Skip to content
This repository has been archived by the owner on May 30, 2024. It is now read-only.

Break up Basic pallet example into smaller pallets #27

Open
sacha-l opened this issue Sep 13, 2023 · 1 comment
Open

Break up Basic pallet example into smaller pallets #27

sacha-l opened this issue Sep 13, 2023 · 1 comment
Assignees
@sacha-l

Comments

@sacha-l
Copy link

sacha-l commented Sep 13, 2023

The Basic Example pallet is really useful but could probably be broken down into smaller example pallets, focusing on the different things it demonstrates for e.g.:

  • different ways to configure weights
  • examples of signed extensions
  • examples of storages
  • best practices for using internal public/private functions

Although this pallet has basic functionality in terms of what it does it by no means is basic 🫠
@sacha-l sacha-l self-assigned this Sep 13, 2023
@sacha-l sacha-l mentioned this issue Sep 13, 2023
Merged
@kianenigma
Copy link
Collaborator

I think a lot of these topics are essentially reference docs and should be moved to this format, as opposed to an example pallet. See my comment in paritytech/polkadot-sdk#1554 (review). Suggest concluding this before making example pallets.

sacha-l pushed a commit to paritytech/polkadot-sdk that referenced this issue Sep 18, 2023
[improve docs] Example pallet crate and Basic Example pallet (#1546)
1d5a9d2 
This fixes the broken links in the crate level documentation of the
Examples crate. It also updates the documentation for the Basic Example
pallet by removing the template for documenting a pallet (we now have
[this](https://github.com/paritytech/polkadot-sdk/blob/master/docs/DOCUMENTATION_GUIDELINE.md)
to refer to instead).

Note: I found it unnecessary to provide a link to the doc guidelines as
I don't think this would be where someone should discover them. I also
want to flag some ideas that came while making these minor improvements
in [this
issue](paritytech/polkadot-sdk-docs#27) (for a
subsequent PR) as part of ongoing docs work.
bgallois pushed a commit to duniter/duniter-polkadot-sdk that referenced this issue Mar 25, 2024
[improve docs] Example pallet crate and Basic Example pallet (parityt…
e82c264 
…ech#1546)

This fixes the broken links in the crate level documentation of the
Examples crate. It also updates the documentation for the Basic Example
pallet by removing the template for documenting a pallet (we now have
[this](https://github.com/paritytech/polkadot-sdk/blob/master/docs/DOCUMENTATION_GUIDELINE.md)
to refer to instead).

Note: I found it unnecessary to provide a link to the doc guidelines as
I don't think this would be where someone should discover them. I also
want to flag some ideas that came while making these minor improvements
in [this
issue](paritytech/polkadot-sdk-docs#27) (for a
subsequent PR) as part of ongoing docs work.
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@sacha-l sacha-l

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@kianenigma @sacha-l