Skip to content

Add documentation around FRAME Origin#3362

Merged
kianenigma merged 29 commits intomasterfrom
kiz-origin-docs
Feb 27, 2024
Merged

Add documentation around FRAME Origin#3362
kianenigma merged 29 commits intomasterfrom
kiz-origin-docs

Conversation

@kianenigma
Copy link
Copy Markdown
Contributor

@kianenigma kianenigma commented Feb 16, 2024 •
edited
Loading

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:
Screenshot 2024-02-20 at 12 16 00

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

@kianenigma kianenigma added the T11-documentation This PR/Issue is related to documentation. label Feb 16, 2024
@kianenigma kianenigma requested a review from a team as a code owner February 16, 2024 14:39
@kianenigma kianenigma added the R0-no-crate-publish-required The change does not require any crates to be re-published. label Feb 16, 2024
@kianenigma kianenigma mentioned this pull request Feb 16, 2024
Merged
DrW3RK
DrW3RK reviewed Feb 20, 2024
View reviewed changes
Copy link
Copy Markdown
Contributor

@DrW3RK DrW3RK left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the write-up on origins!

@kianenigma kianenigma requested a review from a team as a code owner February 20, 2024 13:22
skunert
skunert reviewed Feb 22, 2024
View reviewed changes
Copy link
Copy Markdown
Contributor

@skunert skunert left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 🤔
Screenshot from 2024-02-22 10-44-41

vs

Screenshot from 2024-02-22 10-44-33

kianenigma
kianenigma commented Feb 23, 2024
View reviewed changes
@kianenigma @skunert
Apply suggestions from code review
ba1d800 
Co-authored-by: Sebastian Kunert <skunert49@gmail.com>
kianenigma
kianenigma commented Feb 23, 2024
View reviewed changes
@paritytech-review-bot paritytech-review-bot bot requested a review from a team February 23, 2024 10:24
@kianenigma kianenigma mentioned this pull request Feb 23, 2024
Merged
gpestana
gpestana approved these changes Feb 23, 2024
View reviewed changes
liamaharon
liamaharon approved these changes Feb 26, 2024
View reviewed changes
Copy link
Copy Markdown
Contributor

@liamaharon liamaharon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

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)).
Copy link
Copy Markdown
Contributor

@liamaharon liamaharon Feb 26, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Copy Markdown
Contributor Author

@kianenigma kianenigma Feb 26, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

kianenigma and others added 4 commits February 26, 2024 10:14
@kianenigma @liamaharon
Update docs/sdk/src/reference_docs/mod.rs
95ccf8e 
Co-authored-by: Liam Aharon <liam.aharon@hotmail.com>
@kianenigma @liamaharon
Update docs/sdk/src/reference_docs/frame_origin.rs
4e18167 
Co-authored-by: Liam Aharon <liam.aharon@hotmail.com>
@kianenigma @liamaharon
Update docs/sdk/src/reference_docs/frame_origin.rs
7e99fb8 
Co-authored-by: Liam Aharon <liam.aharon@hotmail.com>
@kianenigma
Merge branch 'master' into kiz-origin-docs
51feebe
muharem
muharem approved these changes Feb 27, 2024
View reviewed changes
Copy link
Copy Markdown
Contributor

@muharem muharem left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

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

@kianenigma
Copy link
Copy Markdown
Contributor Author

kianenigma commented Feb 27, 2024

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.

@kianenigma kianenigma enabled auto-merge February 27, 2024 10:49
@kianenigma kianenigma added this pull request to the merge queue Feb 27, 2024
@kianenigma kianenigma mentioned this pull request Feb 27, 2024
Open
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to no response for status checks Feb 27, 2024
@kianenigma kianenigma added this pull request to the merge queue Feb 27, 2024
Merged via the queue into master with commit 29369a4 Feb 27, 2024
@kianenigma kianenigma deleted the kiz-origin-docs branch February 27, 2024 16:21
ordian added a commit that referenced this pull request Feb 28, 2024
@ordian
Merge remote-tracking branch 'origin/master' into ao-collator-parent-…
8b70d0f 
…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)
  ...
bgallois pushed a commit to duniter/duniter-polkadot-sdk that referenced this pull request Mar 25, 2024
@kianenigma @DrW3RK
@skunert @gpestana @liamaharon
Add documentation around FRAME Origin (paritytech#3362)
f6b16f2 
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>
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

@skunert skunert skunert approved these changes

@muharem muharem muharem approved these changes

@alvicsam alvicsam alvicsam approved these changes

+3 more reviewers

@DrW3RK DrW3RK DrW3RK left review comments

@gpestana gpestana gpestana approved these changes

@liamaharon liamaharon liamaharon approved these changes

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.

Ref docs for frame_composite_enums Ref docs for frame_origin

7 participants

@kianenigma @gpestana @skunert @muharem @liamaharon @alvicsam @DrW3RK