Skip to content

chore: fix broken links #25088

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
Closed
wants to merge 6 commits into from
Closed

chore: fix broken links #25088

wants to merge 6 commits into from

Conversation

@radik878
Copy link
Contributor

@radik878 radik878 commented Aug 4, 2025 •
edited by coderabbitai bot
Loading

Old broken link:
https://github.com/cometbft/cometbft/v2/blob/main/spec/abci/abci%2B%2B_basic_concepts.md
New correct link:
https://docs.cometbft.com/v0.37/spec/abci/abci++_basic_concepts

Old broken link:
https://github.com/cometbft/cometbft/v2/blob/main/spec/abci/abci++_basic_concepts
New correct link:
https://docs.cometbft.com/v0.37/spec/abci/abci++_basic_concepts

Old broken link:
https://docs.cometbft.com/v0.37/spec/p2p/messages/mempool/
New correct link:
https://docs.cometbft.com/v0.37/spec/p2p/legacy-docs/messages/mempool/

Old broken link:
https://github.com/cosmos/cosmos-sdk/tree/main/x/auth/spec
New correct link:
https://github.com/cosmos/cosmos-sdk/blob/main/x/auth/README.md

Summary by CodeRabbit

  • Documentation
    • Updated various documentation links to reference the latest official CometBFT documentation and legacy-docs where appropriate.
    • Improved accuracy of references in comments and user-facing documentation.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Aug 4, 2025

📝 Walkthrough

Walkthrough

This change updates documentation comments and markdown files to reference new or relocated URLs for CometBFT and Cosmos SDK documentation. No functional code, logic, or control flow has been altered; only documentation links have been revised to point to official or legacy documentation sources.

Changes

Cohort / File(s) Change Summary
BaseApp ABCI++ Documentation Links
baseapp/abci.go, types/staking.go		 Updated documentation comment URLs from GitHub to the official CometBFT documentation site for ABCI++ concepts.
Beginner Docs Reference Updates
docs/docs/learn/beginner/01-tx-lifecycle.md		 Changed ABCI and mempool message links to "legacy-docs" versions and updated AnteHandler example link.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

  • 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 explain this code block.
  • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using 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 generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests for this 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.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

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.

coderabbitai[bot]
coderabbitai bot reviewed Aug 4, 2025
View reviewed changes
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

♻️ Duplicate comments (1)
baseapp/abci.go (1)

471-471: Same nit as above – duplicate

The same URL appears here; apply the consistency tweak in both spots.

🧹 Nitpick comments (2)
types/staking.go (1)

15-15: Use a version-agnostic URL or keep anchors consistent

Good catch replacing the broken GitHub link.
For long-term maintainability, consider either:

  1. Dropping the hard-coded /v0.37/ segment so future CometBFT upgrades don’t require another sweep, or
  2. Adding the same “#consensus/block-execution-methods” anchor used elsewhere (e.g. this file earlier) so readers land directly on the relevant section.

Pure documentation nit, no code impact.

baseapp/abci.go (1)

392-392: Add anchor or mirror URL style for consistency

All other references (see types/staking.go) include the “#consensus/block-execution-methods” anchor.
Adding it here—or removing it everywhere—will keep the doc comments uniform and drop readers on the exact subsection.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Knowledge Base: Disabled due to Reviews > Disable Knowledge Base setting

📥 Commits

Reviewing files that changed from the base of the PR and between d458d9e and 3e69e26.

📒 Files selected for processing (3)
  • baseapp/abci.go (2 hunks)
  • docs/docs/learn/beginner/01-tx-lifecycle.md (2 hunks)
  • types/staking.go (1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/docs/learn/beginner/01-tx-lifecycle.md

[style] ~76-~76: ‘Prior to’ might be wordy. Consider a shorter alternative.
Context: ...rd a Tx if it is found to be invalid. Prior to consensus, nodes continuously check inc...

(EN_WORDINESS_PREMIUM_PRIOR_TO)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: Summary
🔇 Additional comments (2)
docs/docs/learn/beginner/01-tx-lifecycle.md (2)

74-77: Updated CometBFT links resolve correctly

The switch to the legacy-docs/messages paths fixes the 404s and keeps the version in sync with the rest of the docs. Looks good.

129-129: Auth module link fixed

Confirming the new link points to the README and renders fine. No further action needed.

@aljo242 aljo242 closed this Aug 4, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@radik878 @aljo242