-
Notifications
You must be signed in to change notification settings - Fork 3.7k
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 invalid multiple links #23039
Conversation
"[auth (authentication)](../modules/auth/)" is invalid. Changed to "[auth (authentication)](../auth/)"
"[x/staking SPEC](../../build/modules/staking/README.md" is not invalid. Changed to "[x/staking SPEC](/x/staking/README.md)"
"[x/staking SPEC](../../build/modules/staking/README.md)" is invalid. Changed to "[x/staking SPEC](/x/staking/README.md)"
"[authz module](../modules/authz/)" is invalid. Changed to "[authz module](../authz/)"
📝 WalkthroughWalkthroughThis pull request focuses on documentation updates across multiple files in the Cosmos SDK, primarily addressing broken or incorrect links and improving the clarity of documentation. The changes involve correcting relative paths in markdown files for modules like Changes
Possibly related issues
Possibly related PRs
Suggested labels
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
|
There was a problem hiding this 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
🧹 Nitpick comments (1)
docs/learn/advanced/08-events.md (1)
Line range hint
1-100
: Documentation improvements suggestedWhile reviewing the entire document, I noticed a few areas that could be improved:
- The Events table could benefit from consistent punctuation at the end of descriptions
- The WebSocket example could include a real-world response format to help developers understand what to expect
Would you like me to propose specific improvements for these sections?
📜 Review details
Configuration used: .coderabbit.yml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
docs/learn/advanced/08-events.md
(1 hunks)docs/learn/beginner/02-query-lifecycle.md
(2 hunks)x/auth/README.md
(1 hunks)x/authz/README.md
(1 hunks)
✅ Files skipped from review due to trivial changes (3)
- x/authz/README.md
- docs/learn/beginner/02-query-lifecycle.md
- x/auth/README.md
🧰 Additional context used
📓 Path-based instructions (1)
docs/learn/advanced/08-events.md (1)
Pattern **/*.md
: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"
🔇 Additional comments (1)
docs/learn/advanced/08-events.md (1)
59-59
: Verify the updated staking module documentation link
The link update to /x/staking/README.md
aligns with the PR objectives. Let's verify that this path exists and is accessible.
✅ Verification successful
Link update to /x/staking/README.md
is valid
The new path /x/staking/README.md
exists in the repository, confirming that the documentation link update is correct and accessible.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Verify the existence of the staking module documentation
# Expected: File should exist at the new path
# Check if the new path exists
fd -t f "README.md" x/staking/
Length of output: 50
@@ -56,7 +56,7 @@ The following examples show how to query Events using the Cosmos SDK. | |||
| `tx.height=23` | Query all transactions at height 23 | | |||
| `message.action='/cosmos.bank.v1beta1.Msg/Send'` | Query all transactions containing an x/bank `Send` [Service `Msg`](../../build/building-modules/03-msg-services.md). Note the `'`s around the value. | | |||
| `message.module='bank'` | Query all transactions containing messages from the x/bank module. Note the `'`s around the value. | | |||
| `create_validator.validator='cosmosval1...'` | x/staking-specific Event, see [x/staking SPEC](../../build/modules/staking/README.md). | | |||
| `create_validator.validator='cosmosval1...'` | x/staking-specific Event, see [x/staking SPEC](/x/staking/README.md). | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this works when the docs site is generated.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
thank you for the pr but these links work correctly when the docs site is generated. If we accept this pr it will work on github but not on the docs site
Description
I've checked every ‘md’ files in the repository and found some broken links that needed to be fixed.
1. "(../modules/authz/)" -> "(../authz/)"
cosmos-sdk/x/auth/README.md
Line 35 in 6ed9452
2. "(../../build/modules/staking/README.md)" -> "(/x/staking/README.md)"
cosmos-sdk/docs/learn/beginner/02-query-lifecycle.md
Line 20 in 6ed9452
cosmos-sdk/docs/learn/beginner/02-query-lifecycle.md
Line 30 in 6ed9452
3. "(../../build/modules/staking/README.md" -> "(/x/staking/README.md)"
cosmos-sdk/docs/learn/advanced/08-events.md
Line 59 in 6ed9452
4. "(../modules/auth/)" -> "(../auth/)"
cosmos-sdk/x/authz/README.md
Line 43 in 6ed9452
Hope this helps.
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.md
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...
Summary by CodeRabbit
08-events.md
regarding event handling in the Cosmos SDK.02-query-lifecycle.md
to point directly to thestaking
module documentation.x/auth/README.md
andx/authz/README.md
to accurately reflect the directory structure.