Add documentation around FRAME Origin #3362

kianenigma · 2024-02-16T14:39:41Z

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:

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 paritytech/polkadot-sdk-docs#45
closes paritytech/polkadot-sdk-docs#43
contributes / overlaps with #2638 cc @liamaharon
deprecation companion: polkadot-developers/substrate-docs#2131
pba-content companion: Polkadot-Blockchain-Academy/pba-content#977

DrW3RK

Thanks for the write-up on origins!

docs/sdk/src/reference_docs/frame_origin.rs

docs/sdk/src/reference_docs/frame_runtime_types.rs

Co-authored-by: Radha <86818441+DrW3RK@users.noreply.github.com>

…into kiz-origin-docs

skunert

Nice docs!

When I run locally it seems like the theming is inconsistent. On some pages I have the default theme and it switches randomly to a darker theme (browser: firefox). Not sure if this is an issue on my end 🤔

vs

docs/sdk/src/meta_contributing.rs

docs/sdk/src/reference_docs/frame_origin.rs

docs/sdk/src/reference_docs/frame_runtime_types.rs

docs/sdk/src/reference_docs/frame_origin.rs

Co-authored-by: Sebastian Kunert <skunert49@gmail.com>

docs/sdk/src/reference_docs/mod.rs

…origin-docs

…into kiz-origin-docs

docs/sdk/src/reference_docs/frame_origin.rs

Co-authored-by: Gonçalo Pestana <g6pestana@gmail.com>

liamaharon

Some comments but overall doc looks good. Also, theme looks great 👍🏼

docs/sdk/src/reference_docs/mod.rs

docs/sdk/src/reference_docs/frame_origin.rs

liamaharon · 2024-02-26T05:14:15Z

docs/sdk/src/reference_docs/frame_origin.rs

+//! example:
+//!
+//! * If the majority of token holders agreed upon this. This is more or less what the
+//!   [`pallet_democracy`] does under the hood ([reference](https://github.com/paritytech/polkadot-sdk/blob/edd95b3749754d2ed0c5738588e872c87be91624/substrate/frame/democracy/src/lib.rs#L1603-L1633)).


Is this an example of using the Origin abstraction? Seems just like regular logic

It is meant to showcase that pallets can dispatch internally and set any origin. And, that an origin like root can only be acquired in this way.

I will re-read it one more time.

docs/sdk/src/reference_docs/frame_origin.rs

Co-authored-by: Liam Aharon <liam.aharon@hotmail.com>

muharem

Thank you!

It would be also very helpful to have more context for OriginTrait docs, specially methods add_filter, reset_filter, filter_call.

kianenigma · 2024-02-27T10:42:55Z

Thank you!

It would be also very helpful to have more context for OriginTrait docs, specially methods add_filter, reset_filter, filter_call.

This is a great suggestion! will either do here or in a follow-up.

…head-data * origin/master: (51 commits) Runtime Upgrade ref docs and Single Block Migration example pallet (#1554) Collator overseer builder unification (#3335) Introduce storage attr macro `#[disable_try_decode_storage]` and set it on `System::Events` and `ParachainSystem::HostConfiguration` (#3454) Add Polkadotters bootnoders per IBP application (#3423) Add documentation around FRAME Origin (#3362) Bridge zombienet tests: Check amount received at destination (#3490) Snowbridge benchmark tests fix (#3424) fix(zombienet): increase timeout in download artifacts (#3376) Cleanup String::from_utf8 (#3446) [prdoc] Validate crate names (#3467) Limit max execution time for `test-linux-stable` CI jobs (#3483) Introduce Notification block pinning limit (#2935) frame-support: Improve error reporting when having too many pallets (#3478) add Encointer as trusted teleporter for Westend (#3411) [pallet-xcm] Adjust benchmarks (teleport_assets/reserve_transfer_assets) not relying on ED (#3464) Add more debug logs to understand if statement-distribution misbehaving (#3419) Remove redundant parachains assigner pallet. (#3457) Use generic hash for runtime wasm in resolve_state_version_from_wasm (#3447) Runtime: allow backing multiple candidates of same parachain on different cores (#3231) Bridge zombienet tests: move all "framework" files under one folder (#3462) ...

@liamaharon

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 paritytech/polkadot-sdk-docs#45 closes paritytech/polkadot-sdk-docs#43 contributes / overlaps with paritytech#2638 cc @liamaharon deprecation companion: polkadot-developers/substrate-docs#2131 pba-content companion: Polkadot-Blockchain-Academy/pba-content#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>

kianenigma added 6 commits February 15, 2024 21:31

add origin related articles

1ffe06c

make it build

bb3dffe

add macro docs as well

39fac87

add diagram

c863d75

fix mmd path

acad0ea

Master.into()

8d047fb

kianenigma added the T11-documentation This PR/Issue is related to documentation. label Feb 16, 2024

kianenigma requested a review from a team as a code owner February 16, 2024 14:39

kianenigma added the R0-silent Changes should not be mentioned in any release notes label Feb 16, 2024

kianenigma mentioned this pull request Feb 16, 2024

deprecate origin page polkadot-developers/substrate-docs#2131

Merged

DrW3RK reviewed Feb 20, 2024

View reviewed changes

kianenigma and others added 3 commits February 20, 2024 11:32

Apply suggestions from code review

552ba03

Co-authored-by: Radha <86818441+DrW3RK@users.noreply.github.com>

prettify the docs page a bit

26a9dfa

Merge branch 'kiz-origin-docs' of github.com:paritytech/polkadot-sdk …

e2a24bc

…into kiz-origin-docs

kianenigma requested a review from a team as a code owner February 20, 2024 13:22

kianenigma and others added 3 commits February 20, 2024 13:23

fmt

f71e3a7

fmt agian

0fc5df9

Merge branch 'master' into kiz-origin-docs

9ae0336

skunert reviewed Feb 22, 2024

View reviewed changes

kianenigma commented Feb 23, 2024

View reviewed changes

docs/sdk/src/reference_docs/frame_origin.rs Outdated Show resolved Hide resolved

Apply suggestions from code review

ba1d800

Co-authored-by: Sebastian Kunert <skunert49@gmail.com>

kianenigma commented Feb 23, 2024

View reviewed changes

docs/sdk/src/reference_docs/mod.rs Outdated Show resolved Hide resolved

kianenigma and others added 3 commits February 23, 2024 10:21

fix

e5bcfef

Merge branch 'master' of github.com:paritytech/polkadot-sdk into kiz-…

83a936f

…origin-docs

Update docs/sdk/src/reference_docs/mod.rs

bc00706

alvicsam approved these changes Feb 23, 2024

View reviewed changes

paritytech-review-bot bot requested a review from a team February 23, 2024 10:24

kianenigma added 2 commits February 23, 2024 10:28

fmt

b817e84

Merge branch 'kiz-origin-docs' of github.com:paritytech/polkadot-sdk …

e9746a9

…into kiz-origin-docs

kianenigma mentioned this pull request Feb 23, 2024

add reference for two new ref docs to FRAME lectures Polkadot-Blockchain-Academy/pba-content#977

Merged

skunert approved these changes Feb 23, 2024

View reviewed changes

Merge branch 'master' into kiz-origin-docs

1c90dba

gpestana approved these changes Feb 23, 2024

View reviewed changes

docs/sdk/src/reference_docs/frame_origin.rs Outdated Show resolved Hide resolved

kianenigma and others added 2 commits February 25, 2024 12:43

Merge branch 'master' into kiz-origin-docs

6cd3f4d

Update docs/sdk/src/reference_docs/frame_origin.rs

c09b833

Co-authored-by: Gonçalo Pestana <g6pestana@gmail.com>

liamaharon approved these changes Feb 26, 2024

View reviewed changes

kianenigma and others added 4 commits February 26, 2024 10:14

Update docs/sdk/src/reference_docs/mod.rs

95ccf8e

Co-authored-by: Liam Aharon <liam.aharon@hotmail.com>

Update docs/sdk/src/reference_docs/frame_origin.rs

4e18167

Co-authored-by: Liam Aharon <liam.aharon@hotmail.com>

Update docs/sdk/src/reference_docs/frame_origin.rs

7e99fb8

Co-authored-by: Liam Aharon <liam.aharon@hotmail.com>

Merge branch 'master' into kiz-origin-docs

51feebe

muharem approved these changes Feb 27, 2024

View reviewed changes

Merge branch 'master' into kiz-origin-docs

86750f3

fix test

4d60745

kianenigma enabled auto-merge February 27, 2024 10:49

kianenigma added 2 commits February 27, 2024 10:50

fmt

f300f0b

try and fix rustdocs build

bd52990

kianenigma added this pull request to the merge queue Feb 27, 2024

kianenigma mentioned this pull request Feb 27, 2024

Ref doc: Origin filters paritytech/polkadot-sdk-docs#74

Open

github-merge-queue bot removed this pull request from the merge queue due to no response for status checks Feb 27, 2024

kianenigma added this pull request to the merge queue Feb 27, 2024

Merged via the queue into master with commit 29369a4 Feb 27, 2024
129 of 130 checks passed

kianenigma deleted the kiz-origin-docs branch February 27, 2024 16:21

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add documentation around FRAME Origin #3362

Add documentation around FRAME Origin #3362

kianenigma commented Feb 16, 2024 •

edited

Loading

DrW3RK left a comment

skunert left a comment

liamaharon left a comment

liamaharon Feb 26, 2024

kianenigma Feb 26, 2024

muharem left a comment

kianenigma commented Feb 27, 2024

Add documentation around FRAME Origin #3362

Add documentation around FRAME Origin #3362

Conversation

kianenigma commented Feb 16, 2024 • edited Loading

DrW3RK left a comment

Choose a reason for hiding this comment

skunert left a comment

Choose a reason for hiding this comment

liamaharon left a comment

Choose a reason for hiding this comment

liamaharon Feb 26, 2024

Choose a reason for hiding this comment

kianenigma Feb 26, 2024

Choose a reason for hiding this comment

muharem left a comment

Choose a reason for hiding this comment

kianenigma commented Feb 27, 2024

kianenigma commented Feb 16, 2024 •

edited

Loading