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.

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

Update Identity pallet README.md #5183

Merged
merged 5 commits into from
Aug 15, 2024
Merged

Conversation

IkerAlus
Copy link
Contributor

Update Identity pallet README.md according to the up-to-date docs, particularly to explain the username concept of the pallet.

@IkerAlus IkerAlus added T2-pallets This PR/Issue is related to a particular pallet. T11-documentation This PR/Issue is related to documentation. labels Jul 30, 2024
@IkerAlus IkerAlus requested a review from a team as a code owner July 30, 2024 10:16
@bkchr
Copy link
Member

bkchr commented Jul 30, 2024

@IkerAlus please update the rust docs.

Copy link
Member

@ggwpez ggwpez left a comment

Choose a reason for hiding this comment

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

I think the README was created from the rustdoc with some CLI. Maybe this one or something similar: https://docs.rs/cargo-readme/latest/cargo_readme/

@IkerAlus
Copy link
Contributor Author

@bkchr The Rust docs are up to date, it was only the README.md file showing outdated info.

@ggwpez ummm makes sense, how can we trigger the update of the README.md file?

@ggwpez
Copy link
Member

ggwpez commented Jul 30, 2024

ummm makes sense, how can we trigger the update of the README.md file?

There is no automated way for this, so just locally running the CLI and pushing it here is fine.

@IkerAlus IkerAlus self-assigned this Aug 2, 2024
@IkerAlus IkerAlus force-pushed the IkerAlus-identity_readme_update branch from 4762cf4 to f0afe7a Compare August 2, 2024 11:17
@paritytech-review-bot paritytech-review-bot bot requested a review from a team August 2, 2024 11:18
@IkerAlus IkerAlus requested a review from ggwpez August 2, 2024 11:18
@ggwpez
Copy link
Member

ggwpez commented Aug 2, 2024

Now the markdown formatting CLI is not happy 🤪

I think it is using something like this npx markdownlint-cli --config .github/.markdownlint.yaml -f --ignore target ..

@IkerAlus
Copy link
Contributor Author

IkerAlus commented Aug 2, 2024

@ggwpez it should be all good now 🙏

@ggwpez ggwpez added the R0-silent Changes should not be mentioned in any release notes label Aug 2, 2024
@ggwpez ggwpez enabled auto-merge August 2, 2024 15:15
@bkchr
Copy link
Member

bkchr commented Aug 15, 2024

@ggwpez please approve

Copy link
Contributor

@seadanda seadanda left a comment

Choose a reason for hiding this comment

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

Needs a prdoc with a bump for pallet-identity to satisfy the semver check as the readme is referenced in the Cargo.toml

@ggwpez ggwpez added this pull request to the merge queue Aug 15, 2024
Merged via the queue into master with commit 048f4b8 Aug 15, 2024
169 of 174 checks passed
@ggwpez ggwpez deleted the IkerAlus-identity_readme_update branch August 15, 2024 11:43
ordian added a commit that referenced this pull request Aug 16, 2024
* master:
  Remove redundant minimal template workspace (#5330)
  approval-distribution: Fix handling of conclude (#5375)
  More logs in `is_potential_spam` from `dispute-coordinator` (#5252)
  Fix zombienet bridges test (#5373)
  Update Readme of the `polkadot` crate (#5326)
  allow for `u8` to be used as hold/freeze reason (#5348)
  Moving cargo check for runtimes to GHA (#5340)
  Update links in the documentation (#5175)
  fix visibility for `pallet_nfts` types used as call arguments (#3634)
  Correct some typos in crates' descriptions (#5262)
  Aura: Ensure we are building on each relay chain fork (#5352)
  Update Identity pallet README.md (#5183)
  Bump trie-db from 0.29.0 to 0.29.1 (#5231)
  [Coretime] Always include UnpaidExecution, not just when revenue is > 0 (#5369)
  [Pools] fix derivation of pool account (#4999)
ordian added a commit that referenced this pull request Aug 16, 2024
* master:
  Remove redundant minimal template workspace (#5330)
  approval-distribution: Fix handling of conclude (#5375)
  More logs in `is_potential_spam` from `dispute-coordinator` (#5252)
  Fix zombienet bridges test (#5373)
  Update Readme of the `polkadot` crate (#5326)
  allow for `u8` to be used as hold/freeze reason (#5348)
  Moving cargo check for runtimes to GHA (#5340)
  Update links in the documentation (#5175)
  fix visibility for `pallet_nfts` types used as call arguments (#3634)
  Correct some typos in crates' descriptions (#5262)
  Aura: Ensure we are building on each relay chain fork (#5352)
  Update Identity pallet README.md (#5183)
  Bump trie-db from 0.29.0 to 0.29.1 (#5231)
  [Coretime] Always include UnpaidExecution, not just when revenue is > 0 (#5369)
  [Pools] fix derivation of pool account (#4999)
  Upgrade accidentally downgraded deps (#5365)
  [Pools] Fix issues with member migration to `DelegateStake` (#4822)
  Unify `no_genesis` check (#5360)
  [CI] Fix prdoc command (#5358)
  Beefy: add benchmarks for `report_fork_voting()` (#5188)
ordian added a commit that referenced this pull request Aug 16, 2024
…ct-candidate-weight

* ao-fix-parainclusion-weight-overestimation:
  Remove redundant minimal template workspace (#5330)
  approval-distribution: Fix handling of conclude (#5375)
  More logs in `is_potential_spam` from `dispute-coordinator` (#5252)
  Fix zombienet bridges test (#5373)
  Update Readme of the `polkadot` crate (#5326)
  allow for `u8` to be used as hold/freeze reason (#5348)
  Moving cargo check for runtimes to GHA (#5340)
  Update links in the documentation (#5175)
  fix visibility for `pallet_nfts` types used as call arguments (#3634)
  Correct some typos in crates' descriptions (#5262)
  Aura: Ensure we are building on each relay chain fork (#5352)
  Update Identity pallet README.md (#5183)
  Bump trie-db from 0.29.0 to 0.29.1 (#5231)
  [Coretime] Always include UnpaidExecution, not just when revenue is > 0 (#5369)
  [Pools] fix derivation of pool account (#4999)
  Upgrade accidentally downgraded deps (#5365)
  [Pools] Fix issues with member migration to `DelegateStake` (#4822)
  Unify `no_genesis` check (#5360)
  [CI] Fix prdoc command (#5358)
  Beefy: add benchmarks for `report_fork_voting()` (#5188)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
R0-silent Changes should not be mentioned in any release notes T2-pallets This PR/Issue is related to a particular pallet. T11-documentation This PR/Issue is related to documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants