-
Notifications
You must be signed in to change notification settings - Fork 58
docs: reword necesary components #546
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
base: main
Are you sure you want to change the base?
Conversation
WalkthroughThe pull request updates the integration instructions in Changes
Sequence Diagram(s)sequenceDiagram
participant Developer as Developer
participant Starter as Cosmos SDK Starter
participant RollkitNode as Rollkit Node (ABCI Handler)
Developer->>Starter: Initiate integration process
Starter->>RollkitNode: Start with new logic using Rollkit node
RollkitNode->>RollkitNode: Leverage rollkit/cometbft as the ABCI client
RollkitNode-->>Developer: Return integration status
Poem
🪧 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
CodeRabbit Configuration File (
|
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 (1)
learn/stack.md (1)
94-94
: Add missing comma for better readability.Add a comma after "specified" to properly separate the conditional clause.
-height (integer or string): height of the requested block. If no height is specified the latest block will be used. If height is set to the string "included", the latest DA included block will be returned. +height (integer or string): height of the requested block. If no height is specified, the latest block will be used. If height is set to the string "included", the latest DA included block will be returned.🧰 Tools
🪛 LanguageTool
[typographical] ~94-~94: It seems that a comma is missing.
Context: ...of the requested block. If no height is specified the latest block will be used. If heigh...(IF_COMMA)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
learn/stack.md
(2 hunks)
🧰 Additional context used
🪛 LanguageTool
learn/stack.md
[typographical] ~94-~94: It seems that a comma is missing.
Context: ...of the requested block. If no height is specified the latest block will be used. If heigh...
(IF_COMMA)
🔇 Additional comments (1)
learn/stack.md (1)
27-30
: LGTM! Clear and improved instructions.The changes effectively clarify the integration process by focusing on the starting logic and providing a direct link to the starter repository.
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 (2)
learn/stack.md (2)
27-27
: Casual Tone in Documentation
The line "No problem! You need to replace the Cosmos SDK Go starting logic with a" introduces a casual tone that might be inconsistent with the overall formality of the documentation. Consider revising this phrasing to maintain a professional and consistent tone.
94-94
: Punctuation Improvement: Missing Comma
There appears to be a missing comma in the parameter description. Consider revising the sentence to:"height (integer or string): height of the requested block. If no height is specified, the latest block will be used. If height is set to the string 'included', the latest DA included block will be returned."
This change will improve readability according to the static analysis hint.
🧰 Tools
🪛 LanguageTool
[typographical] ~94-~94: It seems that a comma is missing.
Context: ...of the requested block. If no height is specified the latest block will be used. If heigh...(IF_COMMA)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
learn/stack.md
(2 hunks)
🧰 Additional context used
🪛 LanguageTool
learn/stack.md
[typographical] ~94-~94: It seems that a comma is missing.
Context: ...of the requested block. If no height is specified the latest block will be used. If heigh...
(IF_COMMA)
🔇 Additional comments (2)
learn/stack.md (2)
29-29
: Updated Repository Reference
The reference torollkit/cosmos-sdk-starter
correctly reflects the new starting repository for integrating Rollkit with the Cosmos SDK.
30-30
: Clarified Starting Handler Description
The updated sentence clearly indicates that the modified starting handler now utilizes a Rollkit node instead of CometBFT as the ABCI client, which aligns with the intended documentation update.
Merge commits are not allowed on this repository
👋🏾
This section https://rollkit.dev/learn/stack#cosmos-sdk was accurate anymore I believe.
Summary by CodeRabbit
Documentation
rollkit/cosmos-sdk
torollkit/cosmos-sdk-starter
.Style