chore: fix doc typos #22984
chore: fix doc typos #22984
Conversation
📝 WalkthroughWalkthroughThe architectural decision record (ADR-040) proposes a significant transformation in the Cosmos SDK's state management approach. The document introduces a transition from the IAVL data structure to a Sparse Merkle Tree (SMT) for state commitments, emphasizing a clear separation between state commitment (SC) and state storage (SS). The proposed architecture aims to optimize performance by utilizing a compute-efficient structure, implementing a flexible Key-Value database approach, and refactoring the MultiStore concept into a more modular RootStore design. Changes
Possibly related issues
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: 0
🔭 Outside diff range comments (1)
docs/architecture/adr-040-storage-and-smt-state-commitments.md (1)
Line range hint
27-27: Fix broken reference linkThe reference link to the IAVL node documentation is malformed.
-). The entire node is hashed, and that hash is used as the key in the underlying database, [ref](https://github.com/cosmos/iavl/blob/master/docs/node/node.md +). The entire node is hashed, and that hash is used as the key in the underlying database, [ref](https://github.com/cosmos/iavl/blob/master/docs/node/node.md)
🧹 Nitpick comments (5)
docs/architecture/adr-040-storage-and-smt-state-commitments.md (5)
Line range hint
5-5: Update the draft dateThe changelog shows a draft date of "2020-01-15" which appears outdated given the context and references in the document (e.g., Verkle Trie from 2021).
-* 2020-01-15: Draft +* 2024-01-15: Draft
Line range hint
35-35: Fix typographical error in citationThe citation marker "[*]" is orphaned without a corresponding reference entry.
-Celestia SMT is based on Diem (called jellyfish) design [*] - it uses a compute-optimised +Celestia SMT is based on Diem (called jellyfish) design - it uses a compute-optimised
Line range hint
35-35: Fix British English spellingThe document uses American English elsewhere, so "optimised" should be "optimized" for consistency.
-it uses a compute-optimised SMT +it uses a compute-optimized SMT
Line range hint
196-197: Address TODO comments in types sectionThere are unresolved TODO comments regarding type review and caching that should be addressed before finalizing the ADR.
Would you like me to help create GitHub issues to track these TODO items?
Line range hint
246-247: Remove or complete key compression sectionThe key compression section is marked as TODO and needs a decision. This should either be completed or moved to a separate ADR as suggested.
Would you like me to help draft the key compression section or create a new ADR for this topic?
📜 Review details
Configuration used: .coderabbit.yml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/architecture/adr-040-storage-and-smt-state-commitments.md(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
docs/architecture/adr-040-storage-and-smt-state-commitments.md (1)
Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"
🔇 Additional comments (2)
docs/architecture/adr-040-storage-and-smt-state-commitments.md (2)
282-282:
Fix markdown list formatting
The reference list has an incorrect line number (282) that breaks the markdown formatting.
-* [IAVL What's Next?](https://github.com/cosmos/cosmos-sdk/issues/7100)
+* [IAVL What's Next?](https://github.com/cosmos/cosmos-sdk/issues/7100)Likely invalid or redundant comment.
Line range hint 1-290: Verify technical accuracy of SMT implementation details
The document references Celestia's SMT implementation but should verify if the described optimizations are still current.
Hey! According to our CONTRIBUTING, we do not accept single typo fix PR. Feel free to combine them in one single PR instead of opening many. |
Description
Fix document typo
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
New Features
BasicRootStore,CommitRootStore, andCacheRootStore.RootStoreConfig.