docs: add a synopsis upgrade doc for 52 #23097
Conversation
📝 WalkthroughWalkthroughThis pull request introduces a comprehensive upgrade guide for transitioning from Cosmos SDK version 0.50 to version 0.52. The document provides detailed instructions for developers on critical changes, including module management modifications, parameter handling updates, and architectural improvements. It covers key aspects such as removing the Changes
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
|
tac0turtle
force-pushed
the
marko/52_tut
branch
from
7c0f9ea to
1fa7f62
Compare
tac0turtle
force-pushed
the
marko/52_tut
branch
from
1fa7f62 to
78e7f3c
Compare
tac0turtle
added
T:Docs
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (5)
docs/build/building-apps/upgrades/0.52.md (5)
171-172: Fix grammatical error in the instructionsThe sentence structure needs improvement.
-For the same instructions than for legacy app wiring to enable sign mode textual +For the same instructions as for legacy app wiring to enable sign mode textual🧰 Tools
🪛 LanguageTool
[grammar] ~171-~171: Comparison is written ‘the same … as’.
Context: ...ly the case). For the same instructions than for legacy app wiring to enable sign mo...(THE_SAME_AS)
135-136: Add missing comma for better readability-The embedding of gRPC-Web was removed. if you would like to continue using gRPC-Web you will need to use [Envoy](https://www.envoyproxy.io/) +The embedding of gRPC-Web was removed. If you would like to continue using gRPC-Web, you will need to use [Envoy](https://www.envoyproxy.io/)🧰 Tools
🪛 LanguageTool
[uncategorized] ~135-~135: Possible missing comma found.
Context: ...f you would like to continue using gRPC-Web you will need to use [Envoy](https://ww...(AI_HYDRA_LEO_MISSING_COMMA)
407-408: Clarify x/validate module requirementsThe instructions about x/validate module usage are ambiguous. Please specify when exactly this module is required and when it can be skipped.
-`x/validate` is a module for antehandlers. If you are using runtime/depinject or v2 this module is required. Skip this step or define your own custom ante/post handlers, see `x/validate` documentation for more details. +`x/validate` is a module for antehandlers. If you are using runtime/depinject or v2, this module is required. If you're not using these features, you can either skip this step or define your own custom ante/post handlers. See `x/validate` documentation for more details.🧰 Tools
🪛 LanguageTool
[uncategorized] ~407-~407: Possible missing comma found.
Context: ... If you are using runtime/depinject or v2 this module is required. Skip this step...(AI_HYDRA_LEO_MISSING_COMMA)
368-369: Fix typo in protocolpool description-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.
513-519: Enhance local testing instructionsConsider adding specific validation steps for critical features:
- Verify parameter migration from x/params to module-managed parameters
- Test unordered transactions if enabled
- Validate protocolpool functionality if x/distribution is used
- Verify account number migration if using x/accounts
📜 Review details
Configuration used: .coderabbit.yml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/build/building-apps/upgrades/0.52.md(1 hunks)docs/build/building-apps/upgrades/_category_.json(1 hunks)
✅ Files skipped from review due to trivial changes (1)
- docs/build/building-apps/upgrades/category.json
🧰 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"
🪛 LanguageTool
docs/build/building-apps/upgrades/0.52.md
[style] ~30-~30: This phrase is redundant (‘I’ stands for ‘Interfaces’). Use simply “APIInterfaces”.
Context: ...rts-to-cosmossdkiox) 11. Adopt Core API Interfaces 12. [Si...
(ACRONYM_TAUTOLOGY)
[uncategorized] ~135-~135: Possible missing comma found.
Context: ...f you would like to continue using gRPC-Web you will need to use [Envoy](https://ww...
(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~171-~171: Comparison is written ‘the same … as’.
Context: ...ly the case). For the same instructions than for legacy app wiring to enable sign mo...
(THE_SAME_AS)
[grammar] ~197-~197: Probably a preposition is missing after ‘corresponding’.
Context: ...ml configuration files by adjusting the corresponding opt option to Mgoogle/protobuf/any.proto=gi...
(ATD_VERBS_TO_COLLOCATION)
[style] ~227-~227: This phrase is redundant (‘I’ stands for ‘Interfaces’). Use simply “APIInterfaces”.
Context: ...sdk.io/x/gov/types" ``` ### Adopt Core API Interfaces Core API has been introduced for modul...
(ACRONYM_TAUTOLOGY)
[grammar] ~229-~229: The verb ‘recommend’ is used with the gerund form.
Context: ...deprecation of sdk.Context, we strongly recommend to use the cosmossdk.io/core/appmodule interfa...
(ADMIT_ENJOY_VB)
[style] ~309-~309: Consider a shorter alternative to avoid wordiness.
Context: ...emain, but you cannot create new ones. In order to create new vesting accounts you need to...
(IN_ORDER_TO_PREMIUM)
[typographical] ~310-~310: It seems that a comma is missing.
Context: ...w ones. In order to create new vesting accounts you need to add the accounts module to ...
(IN_ORDER_TO_VB_COMMA)
[style] ~331-~331: Consider a shorter alternative to avoid wordiness.
Context: ...` ### TX Decoder Setup for x/accounts In order to support x/accounts, you need to initial...
(IN_ORDER_TO_PREMIUM)
[grammar] ~356-~356: Did you mean “be removed”?
Context: ... module was removed entirely and should removed from your application. * Remove code...
(WILL_BASED_ON)
[uncategorized] ~407-~407: Possible missing comma found.
Context: ... If you are using runtime/depinject or v2 this module is required. Skip this step...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~411-~411: Consider a shorter alternative to avoid wordiness.
Context: ... appmodule is the single entry point. In order to make the necessary changes the appmodul...
(IN_ORDER_TO_PREMIUM)
[uncategorized] ~509-~509: Use a comma before ‘or’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...g accounts, etc. If your chain is small or you do not rely on x/upgrade, you can d...
(COMMA_COMPOUND_SENTENCE)
🔇 Additional comments (1)
docs/build/building-apps/upgrades/0.52.md (1)
1-47: Well-structured documentation with clear navigation!
The document follows documentation best practices with proper markdown formatting, clear headings, and a comprehensive table of contents.
🧰 Tools
🪛 LanguageTool
[style] ~30-~30: This phrase is redundant (‘I’ stands for ‘Interfaces’). Use simply “APIInterfaces”.
Context: ...rts-to-cosmossdkiox) 11. Adopt Core API Interfaces 12. [Si...
(ACRONYM_TAUTOLOGY)
julienrbrt
changed the title
Description
This pr adds a short step by step upgrade doc to the documentation. its smaller than the upgrading with some slight other information .
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.mdReviewers 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
New Features
Documentation