chore: readmes + upgrading docs #21271
Conversation
WalkthroughWalkthroughThis update introduces significant enhancements across the Cosmos SDK, focusing on improved user experience, modularity, and the removal of deprecated functionalities. Key features include the ability to overwrite Changes
Sequence Diagram(s)sequenceDiagram
participant Developer
participant CosmosSDK
participant Documentation
Developer->>CosmosSDK: Use new features (e.g., wait-tx)
CosmosSDK-->>Developer: Processes transaction
Developer->>Documentation: Check compatibility
Documentation-->>Developer: Provides dependency information
sequenceDiagram
participant Developer
participant MigrationDocs
Developer->>MigrationDocs: Access migration info for v0.52.x
MigrationDocs-->>Developer: Provides necessary updates
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 as PR comments)
Additionally, you can add CodeRabbit Configuration File (
|
julienrbrt
added
the
backport/v0.52.x
![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
Outside diff range, codebase verification and nitpick comments (14)
collections/CHANGELOG.md (1)
37-37: Add a comma before "but".The sentence "It is basic wrapping of the standard Map methods but is not iterable." would be clearer with a comma before "but".
- Add LookupMap implementation. It is basic wrapping of the standard Map methods but is not iterable. + Add LookupMap implementation. It is basic wrapping of the standard Map methods, but is not iterable.Tools
LanguageTool
[uncategorized] ~37-~37: Possible missing comma found.
Context: ...sic wrapping of the standard Map methods but is not iterable. * [#19343](https://git...(AI_HYDRA_LEO_MISSING_COMMA)
tools/confix/README.md (1)
42-44: Clarify the implications of using confix directly in the application.The tip mentions that using confix directly in the application can have fewer features than using it standalone. It would be helpful to specify which features might be missing or affected.
README.md (1)
69-70: Reword to avoid repetition.The sentence "Core dependencies are the core libraries that an application may depend on. Core dependencies not mentionned here as compatible across all maintained SDK versions." repeats the phrase "Core dependencies". Consider rewording for clarity.
- Core dependencies are the core libraries that an application may depend on. Core dependencies not mentionned here as compatible across all maintained SDK versions. + Core dependencies are the libraries that an application may depend on. Those not mentioned here are compatible across all maintained SDK versions.Tools
LanguageTool
[style] ~69-~69: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ries that an application may depend on. Core dependencies not mentionned here as com...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
UPGRADING.md (5)
Line range hint
10-10: Clarify the use of "Note".The phrase "Note, always read the SimApp section for more information on application wiring updates." could be clearer. Consider rephrasing for better readability.
- Note, always read the **SimApp** section for more information on application wiring updates. + Note: Always read the **SimApp** section for more information on application wiring updates.Tools
LanguageTool
[typographical] ~49-~49: It appears that a comma is missing.
Context: ...es described here. ### SimApp In this section we describe the changes made in Cosmos ...(DURING_THAT_TIME_COMMA)
42-42: Improve link clarity.The link to the release tag could be more descriptive to enhance readability.
- [v0.52.x](https://github.com/cosmos/cosmos-sdk/releases/tag/v0.52.0-alpha.0) + [v0.52.x Release Notes](https://github.com/cosmos/cosmos-sdk/releases/tag/v0.52.0-alpha.0)
44-45: Clarify migration documentation availability.The sentence "Documentation to migrate an application from v0.50.x to server/v2 is available elsewhere." could specify where the documentation is available for better guidance.
- Documentation to migrate an application from v0.50.x to server/v2 is available elsewhere. + Documentation for migrating an application from v0.50.x to server/v2 is available in the [migration guide](link-to-migration-guide).
211-211: Clarify the type relocation.The sentence "The
codectypes.Anyhas moved github.com/cosmos/gogoproto/types/any." could be more precise by specifying that it's a package relocation.- The `codectypes.Any` has moved to `github.com/cosmos/gogoproto/types/any`. + The `codectypes.Any` type has been relocated to the package `github.com/cosmos/gogoproto/types/any`.
218-219: Ensure YAML configuration clarity.The YAML configuration snippet could include a brief explanation of the changes to help users understand the context.
```diff version: v1 plugins: - name: gocosmos out: .. - opt: plugins=grpc,Mgoogle/protobuf/any.proto=github.com/cosmos/cosmos-sdk/codec/types,Mcosmos/orm/v1/orm.proto=cosmossdk.io/orm + opt: plugins=grpc,Mgoogle/protobuf/any.proto=github.com/cosmos/gogoproto/types/any,Mcosmos/orm/v1/orm.proto=cosmossdk.io/orm - name: grpc-gateway out: .. opt: logtostderr=true,allow_colon_final_segments=true</blockquote></details> <details> <summary>CHANGELOG.md (6)</summary><blockquote> `46-46`: **Add a period at the end of the sentence.** The sentence "Simulate nested messages" should end with a period for consistency with other entries. ```diff - Simulate nested messages + Simulate nested messages.
57-57: Clarify the usage ofclient.CreateClientConfig.The sentence "Use
client.CreateClientConfigin place ofclient.ReadFromClientConfig" could be more explicit about the context or reason for this change.Consider adding a brief explanation of why this change was made.
60-60: Correct the term "test e2e tests".The phrase "test e2e tests" is redundant. Consider rephrasing for clarity.
- to broadcast test txns to test e2e tests. + to broadcast transactions for end-to-end (e2e) tests.
125-125: Clarify the description of the bug fix.The description "won't terminate when a key is not found" could be more explicit about the behavior change.
Consider rephrasing to "The
keys deletecommand now handles missing keys gracefully without terminating."
137-137: Ensure consistent use of punctuation.The sentence "do not take a home directory anymore" should end with a period for consistency.
- do not take a home directory anymore + do not take a home directory anymore.
219-219: Add a period at the end of the sentence.The sentence "use
keeper.AccountsModKeeper.NextAccountNumberinstead" should end with a period for consistency with other entries.- use `keeper.AccountsModKeeper.NextAccountNumber` instead + use `keeper.AccountsModKeeper.NextAccountNumber` instead.
Review details
Configuration used: .coderabbit.yml
Review profile: CHILL
Files selected for processing (6)
- CHANGELOG.md (3 hunks)
- README.md (1 hunks)
- UPGRADING.md (3 hunks)
- collections/CHANGELOG.md (2 hunks)
- tools/confix/CHANGELOG.md (1 hunks)
- tools/confix/README.md (2 hunks)
Files skipped from review due to trivial changes (1)
- tools/confix/CHANGELOG.md
Additional context used
Path-based instructions (5)
collections/CHANGELOG.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"tools/confix/README.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"README.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"UPGRADING.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"CHANGELOG.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"
LanguageTool
collections/CHANGELOG.md
[uncategorized] ~37-~37: Possible missing comma found.
Context: ...sic wrapping of the standard Map methods but is not iterable. * [#19343](https://git...(AI_HYDRA_LEO_MISSING_COMMA)
README.md
[style] ~69-~69: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ries that an application may depend on. Core dependencies not mentionned here as com...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
Additional comments not posted (1)
tools/confix/README.md (1)
144-152: Compatibility section looks good.The addition of the compatibility section is clear and informative, providing valuable guidance on version compatibility.
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range, codebase verification and nitpick comments (2)
CHANGELOG.md (2)
46-46: Add a period at the end of the sentence.The sentence "Simulate nested messages" should end with a period for consistency.
- Simulate nested messages + Simulate nested messages.
68-68: Clarify the purpose ofIsGTmethod.The description of the
IsGTmethod fortypes.Coincould be expanded to explain its typical use cases or scenarios where it would be beneficial.Consider adding a brief explanation of when and why this method should be used.
Review details
Configuration used: .coderabbit.yml
Review profile: CHILL
Files selected for processing (1)
- CHANGELOG.md (2 hunks)
Additional context used
Path-based instructions (1)
CHANGELOG.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"
Additional comments not posted (5)
CHANGELOG.md (5)
60-60: Clarify the usage ofclient.CreateClientConfig.The change mentions using
client.CreateClientConfigin place ofclient.ReadFromClientConfig, but does not explain the implications of this change.Clarify whether this change affects existing configurations and if any migration steps are necessary.
74-74: Clarify the role ofcore/transaction.Service.The addition of
core/transaction.Servicein runtime is mentioned, but its purpose and impact on existing functionality are not clear.Provide more context on how this service integrates with the existing architecture and its benefits.
134-134: Clarify the impact of renamingSetProtocolVersion.The change from
SetProtocolVersiontoSetAppVersionshould include any necessary steps developers need to take to accommodate this change.Ensure that the documentation provides guidance on updating code that relies on the old method name.
140-140: Clarify changes to key output functions.The change to
clientkeys.NewKeyOutputand related functions now taking an address codec should include examples or guidance on how to update existing code.Include examples of how to use the new function signatures.
194-194: Clarify changes toHasAminoCodec.The change to the
HasAminoCodecsignature should include examples or guidance on how to update existing code.Provide examples of how to use the updated interface.
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range, codebase verification and nitpick comments (3)
CHANGELOG.md (3)
57-60: Clarify Feature Description.The feature description for overwriting
client.tomlcould be clearer. Consider breaking it into multiple lines for readability.- * (client) [#17513](https://github.com/cosmos/cosmos-sdk/pull/17513) Allow overwriting `client.toml`. Use `client.CreateClientConfig` in place of `client.ReadFromClientConfig` and provide a custom template and a custom config. + * (client) [#17513](https://github.com/cosmos/cosmos-sdk/pull/17513) Allow overwriting `client.toml`. + Use `client.CreateClientConfig` instead of `client.ReadFromClientConfig` and provide a custom template and a custom config.
78-78: Clarify Timeout Timestamp Feature.The description of the
timeout-timestampfeature could benefit from improved clarity and separation of ideas.- * (client/tx) [#20870](https://github.com/cosmos/cosmos-sdk/pull/20870) Add `timeout-timestamp` field for tx body defines time based timeout.Add `WithTimeoutTimestamp` to tx factory. Increased gas cost for processing newly added timeout timestamp field in tx body. + * (client/tx) [#20870](https://github.com/cosmos/cosmos-sdk/pull/20870) Add `timeout-timestamp` field to define a time-based timeout in the transaction body. + Add `WithTimeoutTimestamp` to the transaction factory. Increased gas cost for processing the newly added timeout timestamp field in the transaction body.
126-126: Clarify Bug Fix Description.The description for the
keys deletebug fix could be more explicit about the behavior change.- * (client/keys) [#18562](https://github.com/cosmos/cosmos-sdk/pull/18562) `keys delete` won't terminate when a key is not found. + * (client/keys) [#18562](https://github.com/cosmos/cosmos-sdk/pull/18562) Updated `keys delete` command to handle cases where a key is not found without terminating.
Review details
Configuration used: .coderabbit.yml
Review profile: CHILL
Files selected for processing (2)
- CHANGELOG.md (2 hunks)
- tools/confix/CHANGELOG.md (1 hunks)
Files skipped from review as they are similar to previous changes (1)
- tools/confix/CHANGELOG.md
Additional context used
Path-based instructions (1)
CHANGELOG.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"
Additional comments not posted (2)
CHANGELOG.md (2)
46-46: Ensure Consistent Formatting.The "Features" section should be consistently formatted with sub-bullets where applicable. Reviewers have noted potential missing sub-bullets.
Verification successful
Ensure Consistent Use of Sub-Bullets in "Features" Section
The "Features" section in the
CHANGELOG.mdfile does not consistently use sub-bullets, which can lead to confusion about the structure and hierarchy of the information presented. Please review and adjust the formatting to ensure clarity and consistency.
- Consider using sub-bullets for related items or additional details under each feature to maintain a uniform structure across the changelog.
Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify consistent use of sub-bullets in the "Features" section. # Test: Check for sub-bullets in the "Features" section. rg --type md -A 5 $'### Features\n*' CHANGELOG.mdLength of output: 241
Script:
#!/bin/bash # Description: Verify consistent use of sub-bullets in the "Features" section. # Test: Check for sub-bullets in the "Features" section using multiline mode. rg --type md --multiline -A 5 $'### Features\n*' CHANGELOG.mdLength of output: 18924
134-134: Ensure Consistent Formatting.The "API Breaking Changes" section should be consistently formatted with sub-bullets where applicable. Reviewers have noted potential missing sub-bullets.
(cherry picked from commit 858ec2f) # Conflicts: # CHANGELOG.md # UPGRADING.md # collections/CHANGELOG.md
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: .coderabbit.yml
Review profile: CHILL
Files selected for processing (2)
- CHANGELOG.md (2 hunks)
- tools/confix/CHANGELOG.md (1 hunks)
Files skipped from review as they are similar to previous changes (2)
- CHANGELOG.md
- tools/confix/CHANGELOG.md
* main: (76 commits) docs: more app v2 renaming (#21336) chore: update link in disclaimer (#21339) refactor(x/distribution): audit QA (#21316) docs: rename app v2 to app di when talking about runtime v0 (#21329) feat(schema): specify JSON mapping (#21243) fix(x/authz): bring back msg response in `DispatchActions` (#21044) chore: fix all lint issue since golangci-lint bump (#21326) refactor(x/mint): v0.52 audit x/mint (#21301) chore: fix spelling errors (#21327) feat: export genesis in simapp v2 (#21199) fix(baseapp)!: Halt at height now does not produce the halt height block (#21256) refactor(scripts): remove unused variable (#21320) chore(schema/testing): upgrade to go 1.23 iterators (#21282) chore: readmes + upgrading docs (#21271) feat(client): add auto cli for node service (#21074) ci: fix github workflow vulnerable to script injection (#21304) build(deps): Bump github.com/prometheus/client_golang from 1.19.1 to 1.20.0 (#21307) build(deps): use Go 1.23 instead of Go 1.22 (#21280) refactor(x/auth): audit x/auth changes (#21146) chore: remove todo: "abstract out staking message back to staking" (#21266) ...
Description
Prepares readme + upgrading.md for alpha
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
Bug Fixes
Documentation