Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[improve docs]: Sudo Pallet #1209

Merged
merged 12 commits into from
Sep 11, 2023
Merged

[improve docs]: Sudo Pallet #1209

merged 12 commits into from
Sep 11, 2023

Conversation

sacha-l
Copy link
Contributor

@sacha-l sacha-l commented Aug 28, 2023 •
edited
Loading

This PR improves the docs for the Sudo pallet by following our Documentation Guidelines more closely.

It also adds the docsify crate to surface code snippets in the Examples section.

Note: I'm suggesting that we bring the "Pallet API" section further up to make readers more aware of its existence. This section seems a little buried in the other content otherwise.

Screenshot 2023-08-28 at 1 41 16 PM

@sacha-l sacha-l added A1-insubstantial Pull request requires no code review (e.g., a sub-repository hash update). R0-silent Changes should not be mentioned in any release notes T1-FRAME This PR/Issue is related to core FRAME, the framework. T11-documentation This PR/Issue is related to documentation. labels Aug 28, 2023
@paritytech-ci paritytech-ci requested review from a team August 28, 2023 11:47
juangirini
juangirini approved these changes Aug 28, 2023
View reviewed changes
substrate/frame/sudo/src/lib.rs Outdated Show resolved Hide resolved
kianenigma
kianenigma approved these changes Sep 4, 2023
View reviewed changes
Copy link
Contributor

@kianenigma kianenigma left a comment

Choose a reason for hiding this comment

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

All good, please reflect

Note: I'm suggesting that we bring the "Pallet API" section further up to make readers more aware of its existence. This section seems a little buried in the other content otherwise.

In the guideline and other pallets as well :)

franciscoaguirre
franciscoaguirre approved these changes Sep 4, 2023
View reviewed changes
substrate/frame/sudo/src/lib.rs Outdated Show resolved Hide resolved
ggwpez and others added 2 commits September 6, 2023 14:02
@ggwpez
Merge branch 'master' into sl/sudo-pallet-docs-refactor
26cdb94
@juangirini @franciscoaguirre
Apply suggestions from code review
085d72e 
Co-authored-by: Juan <juangirini@gmail.com>
Co-authored-by: Francisco Aguirre <franciscoaguirreperez@gmail.com>
@sacha-l sacha-l enabled auto-merge (squash) September 6, 2023 12:58
@sacha-l sacha-l requested a review from a team September 11, 2023 13:07
@sacha-l sacha-l merged commit 6df8909 into master Sep 11, 2023
109 of 110 checks passed
@sacha-l sacha-l deleted the sl/sudo-pallet-docs-refactor branch September 11, 2023 15:39
@kiltbot kiltbot mentioned this pull request Oct 19, 2023
Closed
@ahmadkaouk ahmadkaouk mentioned this pull request Nov 16, 2023
Closed
bgallois pushed a commit to duniter/duniter-polkadot-sdk that referenced this pull request Mar 25, 2024
@ggwpez @juangirini @franciscoaguirre
[improve docs]: Sudo Pallet (paritytech#1209)
22f56af 
* refactor docs

* add docify

* nit

* add #![deny(missing_docs)]

* Apply suggestions from code review

Co-authored-by: Juan <juangirini@gmail.com>
Co-authored-by: Francisco Aguirre <franciscoaguirreperez@gmail.com>

---------

Co-authored-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io>
Co-authored-by: Juan <juangirini@gmail.com>
Co-authored-by: Francisco Aguirre <franciscoaguirreperez@gmail.com>
serban300 pushed a commit to serban300/polkadot-sdk that referenced this pull request Apr 8, 2024
@svyatonik @serban300
Unify metric names (paritytech#1209)
ee9ef9a 
* unify metric names

* refactor standalone metrics

* headers sync metrics

* post-merge fix

* fix compilation

* fmt

* fix dashboards

* fix local dashboards

* update Rococo/Wococo runtime version

* remove commented code

* fixed grumbles

* fmt

* fixed widget names
serban300 pushed a commit to serban300/polkadot-sdk that referenced this pull request Apr 8, 2024
@svyatonik @serban300
Unify metric names (paritytech#1209)
e142683 
* unify metric names

* refactor standalone metrics

* headers sync metrics

* post-merge fix

* fix compilation

* fmt

* fix dashboards

* fix local dashboards

* update Rococo/Wococo runtime version

* remove commented code

* fixed grumbles

* fmt

* fixed widget names
serban300 pushed a commit to serban300/polkadot-sdk that referenced this pull request Apr 8, 2024
@svyatonik @serban300
Unify metric names (paritytech#1209)
c82f328 
* unify metric names

* refactor standalone metrics

* headers sync metrics

* post-merge fix

* fix compilation

* fmt

* fix dashboards

* fix local dashboards

* update Rococo/Wococo runtime version

* remove commented code

* fixed grumbles

* fmt

* fixed widget names
serban300 pushed a commit to serban300/polkadot-sdk that referenced this pull request Apr 8, 2024
@svyatonik @serban300
Unify metric names (paritytech#1209)
efb42af 
* unify metric names

* refactor standalone metrics

* headers sync metrics

* post-merge fix

* fix compilation

* fmt

* fix dashboards

* fix local dashboards

* update Rococo/Wococo runtime version

* remove commented code

* fixed grumbles

* fmt

* fixed widget names
serban300 pushed a commit to serban300/polkadot-sdk that referenced this pull request Apr 9, 2024
@svyatonik @serban300
Unify metric names (paritytech#1209)
79fbfd1 
* unify metric names

* refactor standalone metrics

* headers sync metrics

* post-merge fix

* fix compilation

* fmt

* fix dashboards

* fix local dashboards

* update Rococo/Wococo runtime version

* remove commented code

* fixed grumbles

* fmt

* fixed widget names
serban300 pushed a commit to serban300/polkadot-sdk that referenced this pull request Apr 9, 2024
@svyatonik @serban300
Unify metric names (paritytech#1209)
04e829c 
* unify metric names

* refactor standalone metrics

* headers sync metrics

* post-merge fix

* fix compilation

* fmt

* fix dashboards

* fix local dashboards

* update Rococo/Wococo runtime version

* remove commented code

* fixed grumbles

* fmt

* fixed widget names
serban300 pushed a commit to serban300/polkadot-sdk that referenced this pull request Apr 9, 2024
@svyatonik @serban300
Unify metric names (paritytech#1209)
b6e0ab7 
* unify metric names

* refactor standalone metrics

* headers sync metrics

* post-merge fix

* fix compilation

* fmt

* fix dashboards

* fix local dashboards

* update Rococo/Wococo runtime version

* remove commented code

* fixed grumbles

* fmt

* fixed widget names
serban300 pushed a commit to serban300/polkadot-sdk that referenced this pull request Apr 9, 2024
@svyatonik @serban300
Unify metric names (paritytech#1209)
463f6f9 
* unify metric names

* refactor standalone metrics

* headers sync metrics

* post-merge fix

* fix compilation

* fmt

* fix dashboards

* fix local dashboards

* update Rococo/Wococo runtime version

* remove commented code

* fixed grumbles

* fmt

* fixed widget names
serban300 pushed a commit to serban300/polkadot-sdk that referenced this pull request Apr 9, 2024
@svyatonik @serban300
Unify metric names (paritytech#1209)
97ce3e0 
* unify metric names

* refactor standalone metrics

* headers sync metrics

* post-merge fix

* fix compilation

* fmt

* fix dashboards

* fix local dashboards

* update Rococo/Wococo runtime version

* remove commented code

* fixed grumbles

* fmt

* fixed widget names
serban300 pushed a commit to serban300/polkadot-sdk that referenced this pull request Apr 9, 2024
@svyatonik @serban300
Unify metric names (paritytech#1209)
90bc00e 
* unify metric names

* refactor standalone metrics

* headers sync metrics

* post-merge fix

* fix compilation

* fmt

* fix dashboards

* fix local dashboards

* update Rococo/Wococo runtime version

* remove commented code

* fixed grumbles

* fmt

* fixed widget names
serban300 pushed a commit to serban300/polkadot-sdk that referenced this pull request Apr 10, 2024
@svyatonik @serban300
Unify metric names (paritytech#1209)
9953d17 
* unify metric names

* refactor standalone metrics

* headers sync metrics

* post-merge fix

* fix compilation

* fmt

* fix dashboards

* fix local dashboards

* update Rococo/Wococo runtime version

* remove commented code

* fixed grumbles

* fmt

* fixed widget names
serban300 pushed a commit to serban300/polkadot-sdk that referenced this pull request Apr 10, 2024
@svyatonik @serban300
Unify metric names (paritytech#1209)
e53305b 
* unify metric names

* refactor standalone metrics

* headers sync metrics

* post-merge fix

* fix compilation

* fmt

* fix dashboards

* fix local dashboards

* update Rococo/Wococo runtime version

* remove commented code

* fixed grumbles

* fmt

* fixed widget names
bkchr pushed a commit that referenced this pull request Apr 10, 2024
@svyatonik @bkchr
Unify metric names (#1209)
bbf8b51 
* unify metric names

* refactor standalone metrics

* headers sync metrics

* post-merge fix

* fix compilation

* fmt

* fix dashboards

* fix local dashboards

* update Rococo/Wococo runtime version

* remove commented code

* fixed grumbles

* fmt

* fixed widget names
This was referenced Jun 5, 2024
Closed
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sam0x17 sam0x17 sam0x17 approved these changes

@juangirini juangirini juangirini approved these changes

@franciscoaguirre franciscoaguirre franciscoaguirre approved these changes

@kianenigma kianenigma kianenigma approved these changes

@ascjones ascjones Awaiting requested review from ascjones

@aaronbassett aaronbassett Awaiting requested review from aaronbassett

@Ank4n Ank4n Awaiting requested review from Ank4n

Assignees
No one assigned
Labels
A1-insubstantial Pull request requires no code review (e.g., a sub-repository hash update). R0-silent Changes should not be mentioned in any release notes T1-FRAME This PR/Issue is related to core FRAME, the framework. T11-documentation This PR/Issue is related to documentation.
Projects
Documentation
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@sacha-l @sam0x17 @juangirini @franciscoaguirre @kianenigma @ggwpez