docs: update package list #22063
docs: update package list #22063
Conversation
julienrbrt
added
the
backport/v0.52.x
📝 WalkthroughWalkthroughThe pull request updates the Cosmos SDK documentation to include the introduction of version 2 (v2) packages and modifies existing package descriptions. Key changes include the addition of a new "V2" section listing several new packages, enhancements to the "Core" and "State Management" sections, and a renaming of the "Automation" section to "UX". The documentation now incorporates new packages such as 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
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: .coderabbit.yml
Review profile: CHILL
📒 Files selected for processing (1)
- docs/build/packages/README.md (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
docs/build/packages/README.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"
🪛 LanguageTool
docs/build/packages/README.md
[duplication] ~19-~19: Possible typo: you repeated a word
Context: ...ore) - Implementation of the Cosmos SDK store * [Store/v2](https://pkg.go.dev/cosmossdk.io/sto...(ENGLISH_WORD_REPEAT_RULE)
🔇 Additional comments (5)
docs/build/packages/README.md (5)
22-28: LGTM: New V2 section added with clear package descriptions.The addition of the V2 section is a good improvement to the documentation. It clearly separates v2 packages and provides concise descriptions for each new package.
34-35: LGTM: New state management packages added.The addition of the Schema and PostgreSQL indexer packages enhances the state management capabilities of the SDK. The descriptions are clear and concise.
37-39: LGTM: UX section renamed and new Client/v2 package added.The renaming of the section from "Automation" to "UX" better reflects its content. The addition of the Client/v2 package, which powers AutoCLI, is a valuable improvement for user experience.
44-47: LGTM: New utility packages added.The addition of the Core/Testing package for mocking SDK modules and the Errors/v2 package for error handling enhances the utility offerings of the SDK.
52-53: LGTM: SimApp v2 added to Example section.The addition of SimApp v2 as the sample Cosmos SDK v2 chain, alongside the original SimApp, provides clear examples for both versions of the SDK. The emphasis on not importing these packages in applications is maintained, which is important for developers to understand.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~53-~53: The preposition “into” seems more likely in this position than the preposition “in”.
Context: ...in. This package should not be imported in your application.(AI_EN_LECTOR_REPLACEMENT_PREPOSITION_IN_INTO)
(cherry picked from commit 55ec58c)
Co-authored-by: Julien Robert <[email protected]>
Description
ref: #21429
no change required for migrations
opened cosmos/vanity#81 due to missing vanity
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
SimApp v2as a sample for the latest version.Documentation