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

add link to rfc-0001 in broker README #1862

Merged
merged 2 commits into from
Oct 15, 2023
Merged

add link to rfc-0001 in broker README #1862

merged 2 commits into from
Oct 15, 2023

Conversation

takahser
Copy link
Contributor

Description

  • What does this PR do?
    • link added
  • Why are these changes needed?
    • improve docs
  • How were these changes implemented and what do they affect?
    • only concerns docs

@takahser takahser requested review from a team October 12, 2023 12:44
ggwpez
ggwpez approved these changes Oct 12, 2023
View reviewed changes
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.

We should also invest in a proper pallet documentation, currently there is none 🙈

@ggwpez ggwpez added T11-documentation This PR/Issue is related to documentation. R0-silent Changes should not be mentioned in any release notes labels Oct 12, 2023
@takahser
Copy link
Contributor Author

@ggwpez here you go.

ggwpez
ggwpez requested changes Oct 12, 2023
View reviewed changes
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.

Uhm with "pallet documentation" i meant this: https://github.com/paritytech/polkadot-sdk/blob/master/docs/DOCUMENTATION_GUIDELINES.md#pallet-crates
README files are obsolete unter this schema. So either rollback or go all the way please.

@paritytech-ci paritytech-ci requested a review from a team October 12, 2023 21:13
@takahser
Copy link
Contributor Author

takahser commented Oct 13, 2023 •
edited
Loading

@ggwpez ok thx, updated the following:

  • rolled back changes
  • fixed another broken link

Regarding the docs: I'll abstain from updating them for now. If I have the capacity, I'll might do it later in a separate PR.

@bkchr bkchr merged commit c9b51cd into paritytech:master Oct 15, 2023
111 of 117 checks passed
@takahser takahser deleted the patch-1 branch October 16, 2023 08:21
ordian added a commit that referenced this pull request Oct 16, 2023
@ordian
Merge branch 'master' into tsv-disabling-backing
c44093d 
* master: (54 commits)
  Publish `xcm-emulator` crate (#1881)
  Adding migrations to clean Rococo Gov 1 storage & reserved funds (#1849)
  Arkworks Elliptic Curve utils overhaul (#1870)
  Fix typos (#1878)
  fix: GoAhead signal only set when runtime upgrade is enacted from parachain side (#1176)
  Refactor staking ledger (#1484)
  Paired-key Crypto Scheme (#1705)
  Include polkadot version in artifact path (#1828)
  add link to rfc-0001 in broker README (#1862)
  Discard `Executor` (#1855)
  Macros to use path instead of ident (#1474)
  Remove clippy clone-double-ref lint noise (#1860)
  Refactor alliance benchmarks to v2 (#1868)
  Check executor params coherence (#1774)
  frame: use derive-impl for beefy and mmr pallets (#1867)
  sc-consensus-beefy: improve gossip logic (#1852)
  Adds instance support for composite enums (#1857)
  Fix links to implementers' guide (#1865)
  Disabled validators runtime API (#1257)
  Adding `try_state` hook for `Treasury` pallet (#1820)
  ...
ordian added a commit that referenced this pull request Oct 16, 2023
@ordian
Merge branch 'tsv-disabling-backing' into ao-disabling-statement-dist…
b67c19f 
…ribution

* tsv-disabling-backing: (54 commits)
  Publish `xcm-emulator` crate (#1881)
  Adding migrations to clean Rococo Gov 1 storage & reserved funds (#1849)
  Arkworks Elliptic Curve utils overhaul (#1870)
  Fix typos (#1878)
  fix: GoAhead signal only set when runtime upgrade is enacted from parachain side (#1176)
  Refactor staking ledger (#1484)
  Paired-key Crypto Scheme (#1705)
  Include polkadot version in artifact path (#1828)
  add link to rfc-0001 in broker README (#1862)
  Discard `Executor` (#1855)
  Macros to use path instead of ident (#1474)
  Remove clippy clone-double-ref lint noise (#1860)
  Refactor alliance benchmarks to v2 (#1868)
  Check executor params coherence (#1774)
  frame: use derive-impl for beefy and mmr pallets (#1867)
  sc-consensus-beefy: improve gossip logic (#1852)
  Adds instance support for composite enums (#1857)
  Fix links to implementers' guide (#1865)
  Disabled validators runtime API (#1257)
  Adding `try_state` hook for `Treasury` pallet (#1820)
  ...
@kiltbot kiltbot mentioned this pull request Nov 7, 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
@takahser
add link to rfc-0001 in broker README (paritytech#1862)
8339e14 
# Description
- What does this PR do?
  - link added
- Why are these changes needed?
  - improve docs
- How were these changes implemented and what do they affect?
  - only concerns docs
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@joepetrowski joepetrowski joepetrowski approved these changes

@ggwpez ggwpez ggwpez approved these changes

@bkchr bkchr bkchr approved these changes

Assignees
No one assigned
Labels
R0-silent Changes should not be mentioned in any release notes 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.
4 participants
@takahser @bkchr @ggwpez @joepetrowski