Add documentation around FRAME Origin (#3362)
Does the following: - Add a reference doc page named `frame_runtime_types`, which explains what types like `RuntimeOrigin`, `RuntimeCall` etc are. - On top of it, it adds a reference doc page called `frame_origin` which explains a few important patterns that we use around origins - And finally brushes up `#[frame::origin]` docs. - Updates the theme, sidebar and favicon to look like: <img width="1728" alt="Screenshot 2024-02-20 at 12 16 00" src="https://github.com/paritytech/polkadot-sdk/assets/5588131/6d60a16b-2081-411b-8869-43b91920cca9"> All of this was inspired by https://substrate.stackexchange.com/questions/10992/how-do-you-find-the-public-key-for-the-medium-spender-track-origin/10993 closes https://github.com/paritytech/polkadot-sdk-docs/issues/45 closes https://github.com/paritytech/polkadot-sdk-docs/issues/43 contributes / overlaps with https://github.com/paritytech/polkadot-sdk/pull/2638 cc @liamaharon deprecation companion: https://github.com/substrate-developer-hub/substrate-docs/pull/2131 pba-content companion: https://github.com/Polkadot-Blockchain-Academy/pba-content/pull/977 --------- Co-authored-by:Radha <86818441+DrW3RK@users.noreply.github.com> Co-authored-by:
Sebastian Kunert <skunert49@gmail.com> Co-authored-by:
Gonçalo Pestana <g6pestana@gmail.com> Co-authored-by:
Liam Aharon <liam.aharon@hotmail.com>
Showing
- .gitlab/pipeline/build.yml 1 addition, 1 deletion.gitlab/pipeline/build.yml
- Cargo.lock 9 additions, 0 deletionsCargo.lock
- docs/mermaid/IA.mmd 1 addition, 1 deletiondocs/mermaid/IA.mmd
- docs/mermaid/outer_runtime_types.mmd 3 additions, 0 deletionsdocs/mermaid/outer_runtime_types.mmd
- docs/sdk/Cargo.toml 15 additions, 5 deletionsdocs/sdk/Cargo.toml
- docs/sdk/headers/header.html 139 additions, 0 deletionsdocs/sdk/headers/header.html
- docs/sdk/headers/theme.css 16 additions, 0 deletionsdocs/sdk/headers/theme.css
- docs/sdk/src/guides/your_first_pallet/mod.rs 4 additions, 5 deletionsdocs/sdk/src/guides/your_first_pallet/mod.rs
- docs/sdk/src/lib.rs 6 additions, 1 deletiondocs/sdk/src/lib.rs
- docs/sdk/src/meta_contributing.rs 4 additions, 2 deletionsdocs/sdk/src/meta_contributing.rs
- docs/sdk/src/reference_docs/extrinsic_encoding.rs 1 addition, 1 deletiondocs/sdk/src/reference_docs/extrinsic_encoding.rs
- docs/sdk/src/reference_docs/frame_composite_enums.rs 0 additions, 1 deletiondocs/sdk/src/reference_docs/frame_composite_enums.rs
- docs/sdk/src/reference_docs/frame_origin.rs 258 additions, 12 deletionsdocs/sdk/src/reference_docs/frame_origin.rs
- docs/sdk/src/reference_docs/frame_runtime_types.rs 306 additions, 0 deletionsdocs/sdk/src/reference_docs/frame_runtime_types.rs
- docs/sdk/src/reference_docs/mod.rs 4 additions, 4 deletionsdocs/sdk/src/reference_docs/mod.rs
- substrate/frame/src/lib.rs 6 additions, 0 deletionssubstrate/frame/src/lib.rs
- substrate/frame/support/procedural/src/construct_runtime/expand/origin.rs 1 addition, 1 deletion...support/procedural/src/construct_runtime/expand/origin.rs
- substrate/frame/support/procedural/src/lib.rs 3 additions, 14 deletionssubstrate/frame/support/procedural/src/lib.rs
- substrate/frame/support/src/lib.rs 61 additions, 7 deletionssubstrate/frame/support/src/lib.rs
- substrate/frame/system/src/lib.rs 1 addition, 0 deletionssubstrate/frame/system/src/lib.rs
Please register or sign in to comment