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

docs: Fix old links in x/staking #21277

Merged
merged 1 commit into from
Aug 13, 2024
Merged

docs: Fix old links in x/staking #21277

merged 1 commit into from
Aug 13, 2024

Conversation

raynaudoe
Copy link
Contributor

@raynaudoe raynaudoe commented Aug 13, 2024

Description

This PR is related to #20955
Fix links referencing older releases.


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...

  • included the correct type prefix in the PR title, you can find examples of the prefixes below:
  • confirmed ! in the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • reviewed "Files changed" and left comments if necessary
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • updated the relevant documentation or specification, including comments for documenting Go code
  • confirmed all CI checks have passed

Reviewers 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...

  • confirmed the correct type prefix in the PR title
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

Summary by CodeRabbit

  • Documentation
    • Updated links in the staking module documentation to direct users to the latest protocol buffer definitions, ensuring access to current resources for understanding the staking features.
    • Added new content regarding the CommissionRates struct for enhanced clarity.

@raynaudoe raynaudoe added T:Docs Changes and features related to documentation. backport/v0.52.x PR scheduled for inclusion in the v0.52's next stable release labels Aug 13, 2024
Copy link
Contributor

coderabbitai bot commented Aug 13, 2024

Walkthrough

Walkthrough

The recent updates to the Cosmos SDK staking module documentation focus on revising links to the protocol buffer definitions. The links have been updated to direct users to a newer version of the staking.proto and associated files in the release/v0.52.x branch. Additionally, new content about the CommissionRates struct has been added, ensuring that users have access to the most current and relevant information regarding staking implementation.

Changes

Files Updated Change Summary
x/staking/README.md Updated links to protocol buffer definitions from v0.47.0-rc1 to release/v0.52.x. Added content on CommissionRates.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant StakingModule
    participant ProtocolBuffer

    User->>StakingModule: Request staking information
    StakingModule->>ProtocolBuffer: Fetch latest definitions
    ProtocolBuffer-->>StakingModule: Return definitions
    StakingModule-->>User: Provide updated staking information
Loading

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?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@raynaudoe raynaudoe marked this pull request as ready for review August 13, 2024 17:27
@raynaudoe raynaudoe requested a review from a team as a code owner August 13, 2024 17:27
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 072a29c and 6ce56ae.

Files selected for processing (1)
  • x/staking/README.md (17 hunks)
Files skipped from review due to trivial changes (1)
  • x/staking/README.md

Copy link
Member

@tac0turtle tac0turtle left a comment

Choose a reason for hiding this comment

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

Nice find, thank you!!

@julienrbrt julienrbrt added this pull request to the merge queue Aug 13, 2024
Merged via the queue into main with commit 588c780 Aug 13, 2024
94 checks passed
@julienrbrt julienrbrt deleted the eze/staking_docs branch August 13, 2024 19:40
mergify bot pushed a commit that referenced this pull request Aug 13, 2024
julienrbrt pushed a commit that referenced this pull request Aug 13, 2024
Co-authored-by: Ezequiel Raynaudo <raynaudo.ee@gmail.com>
@raynaudoe raynaudoe mentioned this pull request Aug 19, 2024
28 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport/v0.52.x PR scheduled for inclusion in the v0.52's next stable release C:x/staking T:Docs Changes and features related to documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants