paritytech / polkadot-sdk-docs

_THE_ Polkadot SDK Tutorial
19 stars 0 forks source link

Tracking Issue for rust-docs improvements #31

Open kianenigma opened 1 year ago

kianenigma commented 1 year ago

FRAME Macros

For each of these, we should have a macro stub in place (https://paritytech.github.io/polkadot-sdk/master/frame_support/pallet_macros/index.html), and then put the documentation of the macro in the stub.

All rust-docs should be foundational, use real examples etc.

Types, Traits and Items often used in FRAME

Types, Traits and Items often used a runtime

Scan a top level runtime, and see which types are often used. Here are some examples, but more can be added. Some groundwork for this is done in https://github.com/paritytech/substrate/pull/14583/files.

Umbrella crates and their descendants

The developer-hub will have multiple umbrella crates (see here). These umbrella crates are entry points and contain links to many other crates.

As an example, substrate umbrella crate will link to a bunch of CLI, RPC and consensus related crates.

We expect users to traverse these links and click on them. Therefore these crates should have great documentation.

### Subtasks
- [ ] https://github.com/paritytech/polkadot-sdk-docs/issues/35