Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Tokens in FRAME Docs #2802

Merged
merged 61 commits into from
Mar 31, 2024
Merged

Tokens in FRAME Docs #2802

merged 61 commits into from
Mar 31, 2024

Conversation

liamaharon
Copy link
Contributor

@liamaharon liamaharon commented Dec 24, 2023

Closes paritytech/polkadot-sdk-docs#70

WIP PR for an overview of how to develop tokens in FRAME.

  • Tokens in Substrate Ref Doc
    • High-level overview of the token-related logic in FRAME
    • Improve docs with better explanation of how holds, freezes, ed, free balance, etc, all work
  • Update pallet_balances docs
    • Clearly mark what is deprecated (currency)
  • Write fungible trait docs
  • Evaluate and if required update pallet_assets, pallet_uniques, pallet_nfts docs
  • Absorb Ref docs frame currency #2683
  • Audit individual trait method docs, and improve if possible

Feel free to suggest additional TODOs for this PR in the comments

@liamaharon liamaharon added the T11-documentation This PR/Issue is related to documentation. label Dec 24, 2023
@liamaharon liamaharon marked this pull request as ready for review March 15, 2024 02:05
@liamaharon liamaharon requested a review from a team as a code owner March 15, 2024 02:05
Copy link
Contributor

@laboon laboon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just some typo fixes

docs/sdk/src/reference_docs/tokens_in_substrate.rs Outdated Show resolved Hide resolved
substrate/frame/support/src/traits/tokens/fungible/mod.rs Outdated Show resolved Hide resolved
substrate/frame/support/src/traits/tokens/fungible/mod.rs Outdated Show resolved Hide resolved
substrate/frame/support/src/traits/tokens/fungible/mod.rs Outdated Show resolved Hide resolved
substrate/frame/support/src/traits/tokens/fungible/mod.rs Outdated Show resolved Hide resolved
substrate/frame/support/src/traits/tokens/fungible/mod.rs Outdated Show resolved Hide resolved
substrate/frame/support/src/traits/tokens/fungible/mod.rs Outdated Show resolved Hide resolved
docs/sdk/src/reference_docs/mod.rs Outdated Show resolved Hide resolved
docs/sdk/src/reference_docs/tokens_in_substrate.rs Outdated Show resolved Hide resolved
docs/sdk/src/reference_docs/tokens_in_substrate.rs Outdated Show resolved Hide resolved
docs/sdk/src/reference_docs/tokens_in_substrate.rs Outdated Show resolved Hide resolved
docs/sdk/src/reference_docs/tokens_in_substrate.rs Outdated Show resolved Hide resolved
@@ -133,6 +142,8 @@
//!
//! * [`System`](../frame_system/index.html)
//! * [`Support`](../frame_support/index.html)
//!
//! [`tokens_in_substrate`]: ../polkadot_sdk_docs/reference_docs/tokens_in_substrate/index.html
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn't know you could link like that, sweet

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, it's nice for when clippy would otherwise auto-wrap the link.

substrate/frame/balances/src/lib.rs Outdated Show resolved Hide resolved
substrate/frame/support/src/traits/tokens/fungible/mod.rs Outdated Show resolved Hide resolved
substrate/frame/support/src/traits/tokens/fungible/mod.rs Outdated Show resolved Hide resolved
substrate/frame/support/src/traits/tokens/fungible/mod.rs Outdated Show resolved Hide resolved
liamaharon and others added 4 commits March 15, 2024 21:48
Co-authored-by: Bill Laboon <laboon@users.noreply.github.com>
Co-authored-by: Bill Laboon <laboon@users.noreply.github.com>
Co-authored-by: Bill Laboon <laboon@users.noreply.github.com>
Co-authored-by: Bill Laboon <laboon@users.noreply.github.com>
@paritytech-review-bot paritytech-review-bot bot requested a review from a team March 15, 2024 10:48
liamaharon and others added 8 commits March 15, 2024 21:48
Co-authored-by: Bill Laboon <laboon@users.noreply.github.com>
Co-authored-by: Bill Laboon <laboon@users.noreply.github.com>
Co-authored-by: Bill Laboon <laboon@users.noreply.github.com>
Co-authored-by: Francisco Aguirre <franciscoaguirreperez@gmail.com>
Co-authored-by: Francisco Aguirre <franciscoaguirreperez@gmail.com>
Co-authored-by: Francisco Aguirre <franciscoaguirreperez@gmail.com>
Co-authored-by: Francisco Aguirre <franciscoaguirreperez@gmail.com>
Co-authored-by: Francisco Aguirre <franciscoaguirreperez@gmail.com>
docs/sdk/src/reference_docs/frame_tokens.rs Outdated Show resolved Hide resolved
docs/sdk/src/reference_docs/frame_tokens.rs Outdated Show resolved Hide resolved
docs/sdk/src/reference_docs/frame_tokens.rs Outdated Show resolved Hide resolved
docs/sdk/src/reference_docs/frame_tokens.rs Outdated Show resolved Hide resolved
docs/sdk/src/reference_docs/frame_tokens.rs Show resolved Hide resolved
docs/sdk/src/reference_docs/frame_tokens.rs Outdated Show resolved Hide resolved
docs/sdk/src/reference_docs/frame_tokens.rs Outdated Show resolved Hide resolved
liamaharon and others added 2 commits March 26, 2024 21:29
Co-authored-by: Francisco Aguirre <franciscoaguirreperez@gmail.com>
Co-authored-by: Francisco Aguirre <franciscoaguirreperez@gmail.com>
@paritytech-review-bot paritytech-review-bot bot requested a review from a team March 26, 2024 10:30
liamaharon and others added 4 commits March 26, 2024 21:30
Co-authored-by: Francisco Aguirre <franciscoaguirreperez@gmail.com>
Co-authored-by: Francisco Aguirre <franciscoaguirreperez@gmail.com>
Co-authored-by: Francisco Aguirre <franciscoaguirreperez@gmail.com>
Copy link
Contributor

@franciscoaguirre franciscoaguirre left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

docs/sdk/src/reference_docs/frame_tokens.rs Outdated Show resolved Hide resolved
@franciscoaguirre franciscoaguirre added R0-silent Changes should not be mentioned in any release notes and removed R0-silent Changes should not be mentioned in any release notes labels Mar 26, 2024
liamaharon and others added 2 commits March 29, 2024 20:08
Co-authored-by: Francisco Aguirre <franciscoaguirreperez@gmail.com>
@kianenigma kianenigma added the R0-silent Changes should not be mentioned in any release notes label Mar 31, 2024
@liamaharon liamaharon added this pull request to the merge queue Mar 31, 2024
Merged via the queue into master with commit 4125706 Mar 31, 2024
130 of 135 checks passed
@liamaharon liamaharon deleted the liam-tokens-docs branch March 31, 2024 10:25
pgherveou pushed a commit that referenced this pull request Apr 2, 2024
Closes paritytech/polkadot-sdk-docs#70

WIP PR for an overview of how to develop tokens in FRAME. 

- [x] Tokens in Substrate Ref Doc
  - High-level overview of the token-related logic in FRAME
- Improve docs with better explanation of how holds, freezes, ed, free
balance, etc, all work
- [x] Update `pallet_balances` docs
  - Clearly mark what is deprecated (currency)
- [x] Write fungible trait docs
- [x] Evaluate and if required update `pallet_assets`, `pallet_uniques`,
`pallet_nfts` docs
- [x] Absorb #2683
- [x] Audit individual trait method docs, and improve if possible

Feel free to suggest additional TODOs for this PR in the comments

---------

Co-authored-by: Bill Laboon <laboon@users.noreply.github.com>
Co-authored-by: Francisco Aguirre <franciscoaguirreperez@gmail.com>
Co-authored-by: Kian Paimani <5588131+kianenigma@users.noreply.github.com>
Co-authored-by: Sebastian Kunert <skunert49@gmail.com>
dharjeezy pushed a commit to dharjeezy/polkadot-sdk that referenced this pull request Apr 9, 2024
Closes paritytech/polkadot-sdk-docs#70

WIP PR for an overview of how to develop tokens in FRAME. 

- [x] Tokens in Substrate Ref Doc
  - High-level overview of the token-related logic in FRAME
- Improve docs with better explanation of how holds, freezes, ed, free
balance, etc, all work
- [x] Update `pallet_balances` docs
  - Clearly mark what is deprecated (currency)
- [x] Write fungible trait docs
- [x] Evaluate and if required update `pallet_assets`, `pallet_uniques`,
`pallet_nfts` docs
- [x] Absorb paritytech#2683
- [x] Audit individual trait method docs, and improve if possible

Feel free to suggest additional TODOs for this PR in the comments

---------

Co-authored-by: Bill Laboon <laboon@users.noreply.github.com>
Co-authored-by: Francisco Aguirre <franciscoaguirreperez@gmail.com>
Co-authored-by: Kian Paimani <5588131+kianenigma@users.noreply.github.com>
Co-authored-by: Sebastian Kunert <skunert49@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
R0-silent Changes should not be mentioned in any release notes T11-documentation This PR/Issue is related to documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Tokens in Substrate Docs
5 participants