-
Notifications
You must be signed in to change notification settings - Fork 3.8k
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: escape mod reference #23418
Conversation
This commit wraps a path in the docs in backticks. The path breaks JSX on the unified docsite as it is read as an open tag <mod> with no closing.
📝 WalkthroughWalkthroughThe document provides a comprehensive upgrade guide for transitioning from Cosmos SDK v0.50 to v0.52. It details significant architectural and functional changes, including the removal of the 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 (4)
docs/build/building-apps/upgrades/0.52.md (4)
216-216
: Fix typo in module import statement documentation.The line contains a typo that affects readability.
-All modules except auth have been split into their own go.mod and are imported via `cosmossdk.io/x/<mod>`. +All modules except auth have been split into their own go.mod and are imported via `cosmossdk.io/x/<module>`.
Line range hint
383-383
: Fix typo in protocol pool description.There's a spelling error in the word "fot".
-This new module allows teams and the community to create funding opportunities fot the development team and the community. +This new module allows teams and the community to create funding opportunities for the development team and the community.
Line range hint
4-24
: Add version compatibility information.The introduction should explicitly state the minimum Go version required for v0.52 and any other critical dependencies to help users prepare for the upgrade.
Add a "Requirements" section under Prerequisites that includes:
- Minimum Go version
- CometBFT version compatibility range
- Any other critical dependency versions
216-219
: Improve module import migration clarity.The module import migration instructions could be clearer with a complete example showing multiple imports.
Add a more comprehensive example:
import ( - "github.com/cosmos/cosmos-sdk/x/auth" - "github.com/cosmos/cosmos-sdk/x/bank" - "github.com/cosmos/cosmos-sdk/x/gov" + "github.com/cosmos/cosmos-sdk/x/auth" // auth remains in cosmos-sdk + "cosmossdk.io/x/bank" // moved to cosmossdk.io + "cosmossdk.io/x/gov" // moved to cosmossdk.io )
📜 Review details
Configuration used: .coderabbit.yml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/build/building-apps/upgrades/0.52.md
(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
docs/build/building-apps/upgrades/0.52.md (1)
Pattern **/*.md
: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"
🪛 GitHub Actions: Spell Check
docs/build/building-apps/upgrades/0.52.md
[warning] 383-383: Spelling error: 'fot' should be one of: for, fit, dot, rot, cot, got, tot, fog
⏰ Context from checks skipped due to timeout of 90000ms (6)
- GitHub Check: repo-analysis
- GitHub Check: build (arm64)
- GitHub Check: build (amd64)
- GitHub Check: markdown-link-check
- GitHub Check: dependency-review
- GitHub Check: Summary
Co-authored-by: Alex | Interchain Labs <alex@skip.money> (cherry picked from commit 77d4359)
This commit wraps a path in the docs in backticks. The path breaks JSX on the unified docsite as it is read as an open tag with no closing.
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
Release Notes: Cosmos SDK v0.52 Upgrade
Breaking Changes
x/params
andx/crisis
modulesx/accounts
moduleNew Features
x/validate
module for ante/post handlersMigration Requirements
cosmossdk.io/x/...