docs: fix several typos in the document #22098
Conversation
📝 Walkthrough📝 WalkthroughWalkthroughThe pull request introduces a restructured organization for the Cosmos SDK documentation, particularly focusing on the 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
🧹 Outside diff range and nitpick comments (3)
docs/build/abci/01-prepare-proposal.md (2)
27-27: Approved with a minor suggestion for improvementThe clarification about the requirements for implementing a custom
PrepareProposalhandler is excellent. It provides clear guidance on the constraints that must be considered.To further enhance clarity, consider adding a brief explanation of why these constraints are important. For example:
-own `PrepareProposal` handler, you must ensure that the transactions -selected DO NOT exceed the maximum block gas (if set) and the maximum bytes provided -by `req.MaxBytes`. +own `PrepareProposal` handler, you must ensure that the transactions +selected DO NOT exceed the maximum block gas (if set) and the maximum bytes provided +by `req.MaxBytes`. These constraints are crucial for maintaining network stability +and ensuring that blocks can be processed efficiently by all nodes.
Line range hint
1-38: Approved with suggestions for minor improvementsThe changes throughout the document significantly improve the clarity and accuracy of the explanation. However, there are a couple of minor points that could be further enhanced:
- Grammar correction:
-Now, reading mempool twice in the previous sentence is confusing, lets break it down. +Now, reading mempool twice in the previous sentence is confusing, let's break it down.
- Elaboration on priority mempool removal:
Consider adding a brief explanation about why the priority mempool was removed or deprecated, and how this affects transaction ordering. This could provide valuable context for readers familiar with previous versions. For example:
-It's worth noting that the priority mempool -in Comet was removed or deprecated. +It's worth noting that the priority mempool in Comet was removed or deprecated +to simplify the system and reduce complexity, as the benefits of priority-based +ordering can now be more effectively managed at the application level.docs/architecture/adr-002-docs-structure.md (1)
Line range hint
43-50: Improve consistency in folder structure formattingFor better readability and consistency, consider using backticks for all folder and file names in the folder structure.
Suggested change:
* `README`: Landing page of the docs. -* intro: Introductory material. Goal is to have a short explainer of the Cosmos SDK and then channel people to the resources they need. The [Cosmos SDK tutorial](https://github.com/cosmos/sdk-application-tutorial/) will be highlighted, as well as the `godocs`. -* concepts: Contains high-level explanations of the abstractions of the Cosmos SDK. It does not contain specific code implementation and does not need to be updated often. **It is not an API specification of the interfaces**. API spec is the `godoc`. -* clients: Contains specs and info about the various Cosmos SDK clients. -* spec: Contains specs of modules, and others. -* modules: Contains links to `godocs` and the spec of the modules. -* architecture: Contains architecture-related docs like the present one. -* translations: Contains different translations of the documentation. +* `intro`: Introductory material. Goal is to have a short explainer of the Cosmos SDK and then channel people to the resources they need. The [Cosmos SDK tutorial](https://github.com/cosmos/sdk-application-tutorial/) will be highlighted, as well as the `godocs`. +* `concepts`: Contains high-level explanations of the abstractions of the Cosmos SDK. It does not contain specific code implementation and does not need to be updated often. **It is not an API specification of the interfaces**. API spec is the `godoc`. +* `clients`: Contains specs and info about the various Cosmos SDK clients. +* `spec`: Contains specs of modules, and others. +* `modules`: Contains links to `godocs` and the spec of the modules. +* `architecture`: Contains architecture-related docs like the present one. +* `translations`: Contains different translations of the documentation.🧰 Tools
🪛 LanguageTool
[style] ~40-~40: To elevate your writing, try using an alternative expression here.
Context: ...ure/ ``` The files in each sub-folders do not matter and will likely change. What matters is...(MATTERS_RELEVANT)
[uncategorized] ~42-~42: Loose punctuation mark.
Context: ...t matters is the sectioning: *README: Landing page of the docs. *intro: In...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~43-~43: Loose punctuation mark.
Context: ...ME: Landing page of the docs. *intro`: Introductory material. Goal is to have ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~44-~44: Loose punctuation mark.
Context: ...d, as well as thegodocs. *concepts: Contains high-level explanations of the...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~45-~45: Loose punctuation mark.
Context: ...**. API spec is thegodoc. *clients: Contains specs and info about the vario...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~46-~46: Loose punctuation mark.
Context: ...the various Cosmos SDK clients. *spec: Contains specs of modules, and others. ...(UNLIKELY_OPENING_PUNCTUATION)
📜 Review details
Configuration used: .coderabbit.yml
Review profile: CHILL
📒 Files selected for processing (2)
- docs/architecture/adr-002-docs-structure.md (2 hunks)
- docs/build/abci/01-prepare-proposal.md (1 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
docs/architecture/adr-002-docs-structure.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"docs/build/abci/01-prepare-proposal.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"
🪛 LanguageTool
docs/architecture/adr-002-docs-structure.md
[uncategorized] ~43-~43: Loose punctuation mark.
Context: ...ME: Landing page of the docs. *intro`: Introductory material. Goal is to have ...(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~72-~72: There seems to be a noun/verb agreement error. Did you mean “suppresses” or “suppressed”?
Context: ...nks to reworked architecture. * Cleaner suppress build for website docs. * Will help bui...(SINGULAR_NOUN_VERB_AGREEMENT)
🔇 Additional comments (2)
docs/build/abci/01-prepare-proposal.md (1)
Line range hint
39-54: Code examples remain relevant and unchangedThe provided code blocks effectively illustrate the implementation and overriding of the default
PrepareProposalhandler. These examples are crucial for developers looking to customize the proposal handling process.While no changes were made to these code blocks, they continue to serve as valuable references within the context of the updated documentation.
docs/architecture/adr-002-docs-structure.md (1)
Line range hint
1-89: LGTM: Well-structured and informative ADRThe overall structure and content of this Architectural Decision Record (ADR) are clear, well-organized, and informative. It effectively communicates the context, decision, status, and consequences of the proposed documentation restructuring for the Cosmos SDK.
🧰 Tools
🪛 LanguageTool
[style] ~40-~40: To elevate your writing, try using an alternative expression here.
Context: ...ure/ ``` The files in each sub-folders do not matter and will likely change. What matters is...(MATTERS_RELEVANT)
[uncategorized] ~42-~42: Loose punctuation mark.
Context: ...t matters is the sectioning: *README: Landing page of the docs. *intro: In...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~43-~43: Loose punctuation mark.
Context: ...ME: Landing page of the docs. *intro`: Introductory material. Goal is to have ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~44-~44: Loose punctuation mark.
Context: ...d, as well as thegodocs. *concepts: Contains high-level explanations of the...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~45-~45: Loose punctuation mark.
Context: ...**. API spec is thegodoc. *clients: Contains specs and info about the vario...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~46-~46: Loose punctuation mark.
Context: ...the various Cosmos SDK clients. *spec: Contains specs of modules, and others. ...(UNLIKELY_OPENING_PUNCTUATION)
Co-authored-by: Julien Robert <[email protected]>
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (1)
docs/architecture/adr-002-docs-structure.md (1)
69-73: Minor: Ensure consistency in list item punctuationFor improved consistency, consider adding periods at the end of all list items in the "Positive" consequences section. Currently, some items end with periods while others don't.
📜 Review details
Configuration used: .coderabbit.yml
Review profile: CHILL
📒 Files selected for processing (1)
- docs/architecture/adr-002-docs-structure.md (2 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
docs/architecture/adr-002-docs-structure.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"
🪛 LanguageTool
docs/architecture/adr-002-docs-structure.md
[uncategorized] ~43-~43: Loose punctuation mark.
Context: ...ME: Landing page of the docs. *intro`: Introductory material. Goal is to have ...(UNLIKELY_OPENING_PUNCTUATION)
🔇 Additional comments (2)
docs/architecture/adr-002-docs-structure.md (2)
Line range hint
1-89: LGTM: Well-structured and comprehensive ADRThe overall structure and content of this Architectural Decision Record (ADR) for the SDK Documentation Structure are well-organized and comprehensive. It clearly outlines the context, decision, status, consequences, and references, providing a thorough overview of the new documentation structure.
🧰 Tools
🪛 LanguageTool
[style] ~40-~40: To elevate your writing, try using an alternative expression here.
Context: ...ure/ ``` The files in each sub-folders do not matter and will likely change. What matters is...(MATTERS_RELEVANT)
[uncategorized] ~42-~42: Loose punctuation mark.
Context: ...t matters is the sectioning: *README: Landing page of the docs. *intro: In...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~43-~43: Loose punctuation mark.
Context: ...ME: Landing page of the docs. *intro`: Introductory material. Goal is to have ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~44-~44: Loose punctuation mark.
Context: ...d, as well as thegodocs. *concepts: Contains high-level explanations of the...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~45-~45: Loose punctuation mark.
Context: ...**. API spec is thegodoc. *clients: Contains specs and info about the vario...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~46-~46: Loose punctuation mark.
Context: ...the various Cosmos SDK clients. *spec: Contains specs of modules, and others. ...(UNLIKELY_OPENING_PUNCTUATION)
72-72: LGTM: Correct use of "vuepress"The change from "suppress" to "vuepress" is correct and accurately describes a positive consequence of the new documentation structure. This change aligns with the previous reviewer's (julienrbrt) confirmation.
julienrbrt
added
the
backport/v0.52.x
Co-authored-by: Marko <[email protected]> Co-authored-by: Julien Robert <[email protected]> (cherry picked from commit cd2c8ea)
Co-authored-by: XiaoBei <[email protected]>
fix several typos in the document
Closes: #XXXX
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
PrepareProposalprocess within the CometBFT framework, enhancing understanding of transaction handling and block construction.