docs: runtime docs #22816
docs: runtime docs #22816
Conversation
julienrbrt
added
the
backport/v0.52.x
julienrbrt
requested review from
a team,
kocubinski,
facundomedica,
hieuvubk and
aaronc
as code owners
|
Important Review skippedReview was skipped as selected files did not have any reviewable changes. 💤 Files selected but had no reviewable changes (1)
You can disable this status message by setting the 📝 Walkthrough📝 Walkthrough📝 WalkthroughWalkthroughThe pull request introduces extensive documentation updates across multiple files related to the Cosmos SDK, focusing on the Changes
Assessment against linked issues
Possibly related PRs
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: 0
🧹 Outside diff range and nitpick comments (6)
docs/build/building-apps/01-app-go-di.md (2)
9-9: Enhance the introduction with more context.While the introduction correctly emphasizes the runtime package, it would be helpful to briefly explain why the runtime package makes wiring easier.
Consider expanding the introduction:
-The Cosmos SDK allows much easier wiring of an `app.go` thanks to [runtime](./00-runtime.md) and app wiring. +The Cosmos SDK allows much easier wiring of an `app.go` thanks to [runtime](./00-runtime.md) and app wiring, which provides a declarative approach to configure and manage blockchain applications.
Line range hint
50-106: Great addition of alternative configuration formats.The new section about alternative formats (YAML/JSON) is valuable, but the example path could be more generic.
Consider updating the example path reference:
-A more complete example of `app.yaml` can be found [here](https://github.com/cosmosregistry/chain-minimal/blob/mini-v050.2/app/app.yaml). +A more complete example of `app.yaml` can be found in the [chain-minimal repository](https://github.com/cosmosregistry/chain-minimal/blob/mini-v050.2/app/app.yaml).docs/build/building-apps/00-runtime.md (3)
42-48: Fix punctuation in the configuration list.The list of key settings needs consistent punctuation.
Apply this formatting:
-* `app_name`: The name of the application -* `begin_blockers`: List of module names to call during BeginBlock -* `end_blockers`: List of module names to call during EndBlock -* `init_genesis`: Order of module initialization during genesis -* `export_genesis`: Order for exporting module genesis data -* `pre_blockers`: Modules to execute before block processing +* `app_name`: The name of the application. +* `begin_blockers`: List of module names to call during BeginBlock. +* `end_blockers`: List of module names to call during EndBlock. +* `init_genesis`: Order of module initialization during genesis. +* `export_genesis`: Order for exporting module genesis data. +* `pre_blockers`: Modules to execute before block processing.🧰 Tools
🪛 LanguageTool
[uncategorized] ~42-~42: Loose punctuation mark.
Context: ...he following key settings: *app_name: The name of the application * `begin_bl...(UNLIKELY_OPENING_PUNCTUATION)
53-54: Fix missing comma after conjunctive adverb.-By default, the runtime module uses the module name as the store key. However it provides a flexible store key configuration through: +By default, the runtime module uses the module name as the store key. However, it provides a flexible store key configuration through:🧰 Tools
🪛 LanguageTool
[uncategorized] ~53-~53: A comma may be missing after the conjunctive/linking adverb ‘However’.
Context: ... uses the module name as the store key. However it provides a flexible store key config...(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
97-99: Great addition of core services documentation.The explanation of core services is clear and well-structured. Consider adding links to the service interfaces for better reference.
-Runtime registers all [core services](../../learn/advanced/02-core.md) required by modules. -These services include the `store`, the `event manager`, the `context`, and the `logger`. +Runtime registers all [core services](../../learn/advanced/02-core.md) required by modules. +These services include the [`store`](https://pkg.go.dev/cosmossdk.io/store), the [`event manager`](https://pkg.go.dev/github.com/cosmos/cosmos-sdk/types#EventManager), the [`context`](https://pkg.go.dev/context), and the [`logger`](https://pkg.go.dev/cosmossdk.io/log).depinject/README.md (1)
180-180: Update code reference version.The code reference looks good, but consider adding a note about version compatibility.
Add a version compatibility note before the code reference:
+:::note +This example uses Cosmos SDK v0.52.0-beta.2. Ensure you're using a compatible version for your application. +:::
📜 Review details
Configuration used: .coderabbit.yml
Review profile: CHILL
📒 Files selected for processing (5)
depinject/README.md(1 hunks)docs/build/building-apps/00-runtime.md(1 hunks)docs/build/building-apps/01-app-go-di.md(5 hunks)docs/learn/advanced/12-simulation.md(1 hunks)runtime/v2/app.go(1 hunks)
✅ Files skipped from review due to trivial changes (2)
- runtime/v2/app.go
- docs/learn/advanced/12-simulation.md
🧰 Additional context used
📓 Path-based instructions (3)
depinject/README.md (1)
Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"
docs/build/building-apps/00-runtime.md (1)
Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"
docs/build/building-apps/01-app-go-di.md (1)
Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"
🪛 LanguageTool
docs/build/building-apps/00-runtime.md
[uncategorized] ~42-~42: Loose punctuation mark.
Context: ...he following key settings: * app_name: The name of the application * `begin_bl...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~53-~53: A comma may be missing after the conjunctive/linking adverb ‘However’.
Context: ... uses the module name as the store key. However it provides a flexible store key config...
(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
[uncategorized] ~56-~56: Loose punctuation mark.
Context: ...ration through: * override_store_keys: Allows customizing module store keys * ...
(UNLIKELY_OPENING_PUNCTUATION)
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (1)
docs/learn/beginner/00-app-anatomy.md (1)
66-66: Consider simplifying the wordingConsider replacing "in order to" with "to" for better conciseness:
-The application's `appCodec` is used to serialize and deserialize data structures in order to store them +The application's `appCodec` is used to serialize and deserialize data structures to store them🧰 Tools
🪛 LanguageTool
[style] ~66-~66: Consider a shorter alternative to avoid wordiness.
Context: ...rialize and deserialize data structures in order to store them, as stores can only persist ...(IN_ORDER_TO_PREMIUM)
📜 Review details
Configuration used: .coderabbit.yml
Review profile: CHILL
📒 Files selected for processing (1)
docs/learn/beginner/00-app-anatomy.md(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
docs/learn/beginner/00-app-anatomy.md (1)
Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"
🪛 LanguageTool
docs/learn/beginner/00-app-anatomy.md
[style] ~66-~66: Consider a shorter alternative to avoid wordiness.
Context: ...rialize and deserialize data structures in order to store them, as stores can only persist ...
(IN_ORDER_TO_PREMIUM)
🔇 Additional comments (1)
docs/learn/beginner/00-app-anatomy.md (1)
Line range hint 1-24: LGTM! Documentation accurately reflects the current architecture
The documentation provides a clear and accurate explanation of the Cosmos SDK application anatomy, particularly the new runtime package and dependency injection changes.
Also applies to: 60-73
🧰 Tools
🪛 LanguageTool
[style] ~66-~66: Consider a shorter alternative to avoid wordiness.
Context: ...rialize and deserialize data structures in order to store them, as stores can only persist ...
(IN_ORDER_TO_PREMIUM)
|
@Mergifyio backport release/v0.52.x |
✅ Backports have been created
|
(cherry picked from commit aa8266e) # Conflicts: # depinject/README.md # runtime/v2/app.go # simapp/app.go # simapp/simd/cmd/root.go
Co-authored-by: Julien Robert <[email protected]>
(cherry picked from commit aa8266e) # Conflicts: # depinject/README.md # runtime/v2/app.go # simapp/app.go # simapp/simd/cmd/root.go
Description
Closes: #21429
I think we can consider the last part of the documentation update for v0.52.
Putting runtime as the preferred way to build an app. It will help to explain the migration to v2 as it will be runtime -> runtime/v2
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
depinjectframework, including a beta disclaimer and expanded usage examples.runtimepackage documentation, emphasizing its role in managing blockchain applications.01-app-go-di.mdto align with the latest Cosmos SDK version, focusing on module configuration and wiring.12-simulation.mdto reflect the latest changes in theSimAppclass.runtime/v2/app.gofor improved clarity on example setups.00-app-anatomy.mdto enhance clarity on application structure and module integration.