Skip to content

Tokens in FRAME Docs#2802

Merged
liamaharon merged 61 commits intomasterfrom
liam-tokens-docs
Mar 31, 2024
Merged

Tokens in FRAME Docs#2802
liamaharon merged 61 commits intomasterfrom
liam-tokens-docs

Conversation

@liamaharon
Copy link
Copy Markdown
Contributor

@liamaharon liamaharon commented Dec 24, 2023 •
edited
Loading

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 mentioned this pull request Dec 24, 2023
Closed
@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
laboon
laboon reviewed Mar 15, 2024
View reviewed changes
Copy link
Copy Markdown
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

franciscoaguirre
franciscoaguirre reviewed Mar 15, 2024
View reviewed changes
substrate/frame/assets/src/lib.rs Outdated
//! * [`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
Copy Markdown
Contributor

@franciscoaguirre franciscoaguirre Mar 15, 2024

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
Copy Markdown
Contributor Author

@liamaharon liamaharon Mar 15, 2024

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.

@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
@liamaharon @laboon
Update substrate/frame/support/src/traits/tokens/fungible/mod.rs
25c1cb3 
Co-authored-by: Bill Laboon <[email protected]>
@liamaharon @laboon
Update substrate/frame/support/src/traits/tokens/fungible/mod.rs
e86c7a9 
Co-authored-by: Bill Laboon <[email protected]>
@liamaharon @laboon
Update substrate/frame/support/src/traits/tokens/fungible/mod.rs
41a3cb8 
Co-authored-by: Bill Laboon <[email protected]>
@liamaharon @franciscoaguirre
Update docs/sdk/src/reference_docs/mod.rs
f389aa7 
Co-authored-by: Francisco Aguirre <[email protected]>
@liamaharon @franciscoaguirre
Update docs/sdk/src/reference_docs/tokens_in_substrate.rs
9ff81e1 
Co-authored-by: Francisco Aguirre <[email protected]>
@liamaharon @franciscoaguirre
Update docs/sdk/src/reference_docs/tokens_in_substrate.rs
c8d04a9 
Co-authored-by: Francisco Aguirre <[email protected]>
@liamaharon @franciscoaguirre
Update docs/sdk/src/reference_docs/tokens_in_substrate.rs
34d33a3 
Co-authored-by: Francisco Aguirre <[email protected]>
@liamaharon @franciscoaguirre
Update docs/sdk/src/reference_docs/tokens_in_substrate.rs
39227f2 
Co-authored-by: Francisco Aguirre <[email protected]>
franciscoaguirre
franciscoaguirre reviewed Mar 26, 2024
View reviewed changes
@paritytech-review-bot paritytech-review-bot bot requested a review from a team March 26, 2024 10:30
franciscoaguirre
franciscoaguirre approved these changes Mar 26, 2024
View reviewed changes
Copy link
Copy Markdown
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!

@franciscoaguirre franciscoaguirre added R0-no-crate-publish-required The change does not require any crates to be re-published. and removed R0-no-crate-publish-required The change does not require any crates to be re-published. labels Mar 26, 2024
@liamaharon liamaharon enabled auto-merge March 29, 2024 09:08
@kianenigma kianenigma added the R0-no-crate-publish-required The change does not require any crates to be re-published. 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
@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
@liamaharon @laboon
@franciscoaguirre @kianenigma @skunert @pgherveou
Tokens in FRAME Docs (#2802)
5df4d0a 
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 <[email protected]>
Co-authored-by: Francisco Aguirre <[email protected]>
Co-authored-by: Kian Paimani <[email protected]>
Co-authored-by: Sebastian Kunert <[email protected]>
dharjeezy pushed a commit to dharjeezy/polkadot-sdk that referenced this pull request Apr 9, 2024
@liamaharon @laboon
@franciscoaguirre @kianenigma @skunert @dharjeezy
Tokens in FRAME Docs (paritytech#2802)
5d0b0d5 
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 <[email protected]>
Co-authored-by: Francisco Aguirre <[email protected]>
Co-authored-by: Kian Paimani <[email protected]>
Co-authored-by: Sebastian Kunert <[email protected]>
This was referenced Jun 5, 2024
Closed
Closed
Closed
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@kianenigma kianenigma kianenigma approved these changes

@franciscoaguirre franciscoaguirre franciscoaguirre approved these changes

@skunert skunert skunert approved these changes

+1 more reviewer

@laboon laboon laboon left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

R0-no-crate-publish-required The change does not require any crates to be re-published. T11-documentation This PR/Issue is related to documentation.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Tokens in Substrate Docs

5 participants

@liamaharon @laboon @franciscoaguirre @kianenigma @skunert