docs(x/staking-upgrade): fix proto broken links #20202
Conversation
WalkthroughThe changes in this update focus on aligning the URLs in the Changes
Possibly related issues
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
|
@julienrbrt this PR fixes deprecated broken links in modules (broke when sdk go to 50 i guess). Can you please review this PR see if this changes is correct. If yes, i will update other modules later) |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Out of diff range and nitpick comments (5)
x/upgrade/README.md (3)
Line range hint
9-18: Consider revising the abstract for grammatical accuracy and clarity.- `x/upgrade` is an implementation of a Cosmos SDK module that facilitates smoothly - upgrading a live Cosmos chain to a new (breaking) software version. It accomplishes this by - providing a `PreBlocker` hook that prevents the blockchain state machine from - proceeding once a pre-defined upgrade block height has been reached. + `x/upgrade` implements a Cosmos SDK module that facilitates the smooth + upgrading of a live Cosmos chain to a new (breaking) software version. It achieves this by + providing a `PreBlocker` hook that prevents the blockchain state machine from + proceeding past a pre-defined upgrade block height.
Line range hint
37-83: Correct typographical errors and ensure terminology consistency in the Concepts section.- This tool is [Cosmovisor](https://github.com/cosmos/cosmos-sdk/tree/main/tools/cosmovisor#readme). + This tool is [Cosmovisor](https://github.com/cosmos/cosmos-sdk/tree/main/tools/cosmovisor). - `Handler` defines what state migrations need to occur before the new binary Y + `Handler` defines the state migrations needed before the new binary Y - This `StoreLoader` is also application specific and not defined on a per-module basis. + This `StoreLoader` is also application-specific and not defined on a per-module basis.
Line range hint
619-619: Correct the Markdown link formatting in the Resources section.- * [Cosmos Dev Series: Cosmos Blockchain Upgrade](https://medium.com/web3-surfers/cosmos-... + * [Cosmos Dev Series: Cosmos Blockchain Upgrade](https://medium.com/web3-surfers/cosmos-dev-series-cosmos-sdk-based-blockchain-upgrade-b5e99181554c)x/staking/README.md (2)
174-174: Consider rephrasing to "the transaction owner is the bond owner" for conciseness.
627-631: Consider adding a space after the period for better readability.
There was a problem hiding this comment.
@julienrbrt sorry for the late update, i took some days off for our holiday. Should we do this instead?
There was a problem hiding this comment.
lets use a tag, there isnt much benefit to a commit here
There was a problem hiding this comment.
Actionable comments posted: 0
Out of diff range and nitpick comments (9)
x/upgrade/README.md (9)
Line range hint
9-9: Ensure the sentence starts with an uppercase letter for consistency and professionalism.
Line range hint
11-11: Correct the possible spelling mistake: "blockchain stat..." should be "blockchain state..."
Line range hint
16-17: Consider rephrasing to be more concise: "all of the validators need to pause their state machines at exactly the same point" could be "all validators must pause their state machines at the same point."
Line range hint
37-37: Capitalize only proper nouns. Change "Name" to "name" unless it is a specific code element that requires capitalization.
Line range hint
65-65: This expression is usually spelled with a hyphen: "application-specific."
Line range hint
136-136: Correct the possible spelling mistake: "big endian" should be "big-endian" when used as an adjective.
Line range hint
149-149: Consider a shorter alternative to "Any and all proposal related events are emitted through thex/govmodule" such as "All proposal-related events are emitted through thex/govmodule."
Line range hint
166-166: Ensure the sentence starts with an uppercase letter for consistency and professionalism.
Line range hint
619-619: Ensure all markdown links are correctly formatted. It seems there might be an unpaired '[' symbol.
|
closing, reopen if needed. |
Description
Closes: #XXXX
Author Checklist
All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.
I have...
!in the type prefix if API or client breaking changeCHANGELOG.mdReviewers Checklist
All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.
I have...
Summary by CodeRabbit