docs: fix broken links across various documentation files #25057

sashass1315 · 2025-07-30T18:25:16Z

Summary by CodeRabbit

Documentation
- Updated various documentation links to point to the latest or more accurate official resources for CometBFT and Cosmos SDK.
- Corrected and improved URLs in user guides, advanced documentation, and help sections for better navigation and reference accuracy.
- No changes to application functionality or user interface.

coderabbitai · 2025-07-30T18:27:26Z

📝 Walkthrough

Walkthrough

This change updates various documentation URLs in code comments and Markdown documentation files across the project. The updates point to newer, more accurate, or version-specific documentation resources for CometBFT and Cosmos SDK. No functional or logic changes were made to the codebase; only documentation references were modified.

Changes

Cohort / File(s)	Change Summary
BaseApp ABCI Comments `baseapp/abci.go`	Updated documentation URLs in comments for `PrepareProposal` and `ProcessProposal` to point to new CometBFT docs.
Introduction Help Link `docs/docs/Introduction.md`	Corrected "Found an issue?" link by removing an extra "docs/" segment from the GitHub edit URL.
Advanced BaseApp Docs `docs/docs/learn/advanced/00-baseapp.md`	Updated "custom mempool handlers" documentation URLs to new location in Cosmos docs.
Context Consensus Params Doc `docs/docs/learn/advanced/02-context.md`	Updated Consensus Params documentation URL to a versioned CometBFT v0.37 path.
Beginner Tx Lifecycle Docs `docs/docs/learn/beginner/01-tx-lifecycle.md`	Updated three documentation URLs for CometBFT and Cosmos SDK to legacy or more general locations.
Staking Validator Delay Comment `types/staking.go`	Updated the comment URL for `ValidatorUpdateDelay` to point to CometBFT v0.38 docs.
Gov Client Pagination Comment `x/gov/client/utils/query.go`	Updated pagination default comment URL to Go package documentation for CometBFT.

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.

📜 Recent 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 a86597e and 2e2a968.

📒 Files selected for processing (7)

baseapp/abci.go (2 hunks)
docs/docs/Introduction.md (1 hunks)
docs/docs/learn/advanced/00-baseapp.md (2 hunks)
docs/docs/learn/advanced/02-context.md (1 hunks)
docs/docs/learn/beginner/01-tx-lifecycle.md (2 hunks)
types/staking.go (1 hunks)
x/gov/client/utils/query.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 (8)

types/staking.go (1)

15-15: URL update looks correct

The new link resolves to the same section in the official CometBFT docs and is version-pinned—no concerns.

docs/docs/Introduction.md (1)

37-37: Fixed self-edit link 👍

Correcting the extra docs/ segment restores the GitHub edit shortcut. Good catch.

baseapp/abci.go (1)

391-393: Reference URLs switched to stable docs

Both comment links now point to the canonical CometBFT v0.38 docs. Update is accurate and keeps documentation in sync.

Also applies to: 471-472

docs/docs/learn/advanced/00-baseapp.md (1)

169-169: Links now hit the correct mempool section

The new path under build/building-apps/app-mempool is valid and future-proof. Looks good.

Also applies to: 180-180

x/gov/client/utils/query.go (1)

16-16: Comment link modernized

Switching to pkg.go.dev makes the source of truth clearer. No code impact.

docs/docs/learn/beginner/01-tx-lifecycle.md (2)

129-130: Good switch to module README

Linking to the x/auth/README.md gives users immediate high-level context instead of dropping them into the lower-level spec directory. 👍

74-77: URLs are valid and resolve successfully

Both of the checked CometBFT legacy-docs links return HTTP 200, so the current URLs are correct and don’t need adjustment:

https://docs.cometbft.com/v0.37/spec/p2p/legacy-docs/messages/

https://docs.cometbft.com/v0.37/spec/p2p/legacy-docs/messages/mempool

docs/docs/learn/advanced/02-context.md (1)

37-38: Version-pin looks correct

Moving from the unstable master docs to the explicit v0.37 path for consensus-parameter specs improves long-term link stability.

✨ 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.
- @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 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.
- @coderabbitai help me debug CodeRabbit configuration file.

Support

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

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)

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

sashaodessa · 2025-07-30T20:08:01Z

docs/docs/learn/advanced/02-context.md - first fix #25056

aljo242 · 2025-07-31T14:40:14Z

@sashass1315 we have a merge conflict

sashass1315 · 2025-08-07T19:55:31Z

@sashass1315 we have a merge conflict

Resolved

aljo242 · 2025-08-11T19:56:19Z

@sashass1315 more conflicts

sashass1315 added 9 commits July 30, 2025 20:42

Update query.go

739cb03

Update 02-context.md

b39f289

Update 01-tx-lifecycle.md

c6873d6

Update 00-baseapp.md

559333e

Update 01-tx-lifecycle.md

423f75d

Update Introduction.md

a74e39f

Update 01-tx-lifecycle.md

b040c9c

Update abci.go

655f735

Update staking.go

2e2a968

github-project-automation bot added this to Interchain Public Works Jul 30, 2025

github-actions bot added C:CLI C:x/gov labels Jul 30, 2025

sashass1315 added 4 commits July 31, 2025 18:01

Update abci.go

64095d9

Merge branch 'main' into link

61447ee

additional broken link fixed

3649353

Merge branch 'main' into link

0c62df2

Merge branch 'main' into link

bf2f809

aljo242 enabled auto-merge August 11, 2025 20:11

aljo242 approved these changes Aug 11, 2025

View reviewed changes

aljo242 added this pull request to the merge queue Aug 11, 2025

Merged via the queue into cosmos:main with commit 7032ead Aug 11, 2025
42 of 43 checks passed

github-project-automation bot moved this to 🥳 Done in Interchain Public Works Aug 11, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

docs: fix broken links across various documentation files #25057

docs: fix broken links across various documentation files #25057

Uh oh!

sashass1315 commented Jul 30, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Jul 30, 2025

Walkthrough

Changes

Estimated code review effort

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

sashaodessa commented Jul 30, 2025

Uh oh!

aljo242 commented Jul 31, 2025

Uh oh!

sashass1315 commented Aug 7, 2025

Uh oh!

aljo242 commented Aug 11, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

docs: fix broken links across various documentation files #25057

docs: fix broken links across various documentation files #25057

Uh oh!

Conversation

sashass1315 commented Jul 30, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Jul 30, 2025

Walkthrough

Changes

Estimated code review effort

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

sashaodessa commented Jul 30, 2025

Uh oh!

aljo242 commented Jul 31, 2025

Uh oh!

sashass1315 commented Aug 7, 2025

Uh oh!

aljo242 commented Aug 11, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

sashass1315 commented Jul 30, 2025 •

edited by coderabbitai bot

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)