docs: fix spelling errors #23038
docs: fix spelling errors #23038
Conversation
"Bootsrapping" -> "Bootstrapping"
"ServiceRegitrar" -> "ServiceRegistrar"
"fully-qualifed" -> "fully-qualified"
📝 WalkthroughWalkthroughThe pull request encompasses documentation updates focusing on two key architectural decision records (ADRs) and a user guide for running nodes. The first ADR ( Changes
Sequence DiagramsequenceDiagram
participant Module as Application Module
participant CoreAPI as Core API Services
participant Store as Store Service
participant Event as Event Service
Module->>CoreAPI: Register Services
CoreAPI->>Store: Open KV Store
CoreAPI->>Event: Emit Events
Module->>CoreAPI: Perform Genesis Operations
CoreAPI->>Module: Provide Context and Services
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
🧹 Nitpick comments (3)
docs/user/run-node/01-run-node.md (1)
201-201: Improve sentence structure for clarityThe sentence can be simplified to improve readability.
-3. Bootstrapping Comet state in order to start the node after the snapshot has been ingested. +3. Bootstrap Comet state to start the node after ingesting the snapshot.🧰 Tools
🪛 LanguageTool
[style] ~201-~201: Consider a shorter alternative to avoid wordiness.
Context: ...command). 3. Bootstrapping Comet state in order to start the node after the snapshot has b...(IN_ORDER_TO_PREMIUM)
docs/architecture/adr-023-protobuf-naming.md (1)
73-73: Fix punctuation and hyphenationThere are two minor issues in this sentence:
- Missing comma after "names"
- Unnecessary hyphen in "fully-qualified" as "fully" is an adverb ending in 'ly'
-Given that we are using fully-qualified names within +Given that we are using fully qualified names, within🧰 Tools
🪛 LanguageTool
[uncategorized] ~73-~73: Possible missing comma found.
Context: ...stinguish them from other names. Given that we are using fully-qualified names with...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~73-~73: Although a hyphen is possible, it is not necessary in a compound modifier in which the first word is an adverb that ends in ‘ly’.
Context: ...m other names. Given that we are using fully-qualified names withingoogle.protobuf.Anyas w...(HYPHENATED_LY_ADVERB_ADJECTIVE)
docs/architecture/adr-063-core-module-api.md (1)
229-229: Add explanation for the protobuf optionThe mention of
cosmos.msg.v1.serviceprotobuf option would benefit from a brief explanation of its purpose and why it's required forMsgservices.Consider adding a brief explanation like:
"Thecosmos.msg.v1.serviceprotobuf option is required forMsgservices as it enables proper message routing and handling within the Cosmos SDK framework."
📜 Review details
Configuration used: .coderabbit.yml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
docs/architecture/adr-023-protobuf-naming.md(1 hunks)docs/architecture/adr-063-core-module-api.md(1 hunks)docs/user/run-node/01-run-node.md(1 hunks)
🧰 Additional context used
📓 Path-based instructions (3)
docs/architecture/adr-023-protobuf-naming.md (1)
Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"
docs/user/run-node/01-run-node.md (1)
Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"
docs/architecture/adr-063-core-module-api.md (1)
Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"
🪛 LanguageTool
docs/architecture/adr-023-protobuf-naming.md
[uncategorized] ~73-~73: Possible missing comma found.
Context: ...stinguish them from other names. Given that we are using fully-qualified names with...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~73-~73: Although a hyphen is possible, it is not necessary in a compound modifier in which the first word is an adverb that ends in ‘ly’.
Context: ...m other names. Given that we are using fully-qualified names within google.protobuf.Any as w...
(HYPHENATED_LY_ADVERB_ADJECTIVE)
docs/user/run-node/01-run-node.md
[style] ~201-~201: Consider a shorter alternative to avoid wordiness.
Context: ...command). 3. Bootstrapping Comet state in order to start the node after the snapshot has b...
(IN_ORDER_TO_PREMIUM)
Description
I've checked every ‘md’ files in the repository and found some typos that needed to be fixed because they clearly changed the meaning and fixed them.
There were also some awkward wording and punctuation, but I didn't fix those because they don't detract too much from the meaning of the original documentation and don't cause any problems in understanding the documentation.
The commit explains which typos are fixed. Hope this helps.
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
Documentation
Bug Fixes
Chores