docs: Update slashing docs #22107
docs: Update slashing docs #22107
Conversation
📝 WalkthroughWalkthroughThe changes involve updates to the Changes
Possibly related PRs
Suggested reviewers
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 using PR comments)
Other keywords and placeholders
Documentation and Community
|
lucaslopezf
requested review from
testinginprod,
raynaudoe and
a team
as code owners
julienrbrt
added
the
backport/v0.52.x
![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
🧹 Outside diff range and nitpick comments (3)
x/slashing/README.md (3)
146-146: Consider using a stable release version in the protobuf reference URL.The protobuf reference URL has been updated to point to a specific beta version (v0.52.0-beta.1). While this is good for consistency, linking to a beta version might not be ideal for long-term stability of the documentation. Consider using a stable release version instead.
157-157: Consider using a stable release version in the protobuf reference URL.The protobuf reference URL has been updated to point to a specific beta version (v0.52.0-beta.1). While this is good for consistency, linking to a beta version might not be ideal for long-term stability of the documentation. Consider using a stable release version instead.
637-649: Excellent addition of theupdate-params-proposalcommand.The new
update-params-proposalcommand is a valuable addition to the CLI section, allowing users to submit governance proposals for updating slashing module parameters. The example provided is clear and helpful.To further improve this section, consider adding a brief explanation of what happens after the proposal is submitted. For instance, mention that it goes through the standard governance process, including voting, and if approved, the parameters will be updated.
📜 Review details
Configuration used: .coderabbit.yml
Review profile: CHILL
📒 Files selected for processing (1)
- x/slashing/README.md (4 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
x/slashing/README.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"
(cherry picked from commit dda9679)
Description
ref: #21429
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.
Please see Pull Request Reviewer section in the contributing guide for more information on how to review a pull request.
I have...
Summary by CodeRabbit
New Features
update-params-proposalcommand for submitting governance proposals related to slashing module parameters.Documentation
README.mdwith an example of the new command and revised references to protobuf files to a specific Cosmos SDK version.