-
Notifications
You must be signed in to change notification settings - Fork 3.8k
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
docs: update with additional diagram to highlight components more clearly #20612
Conversation
WalkthroughThe update introduces visual aids in the documentation of the Cosmos SDK. Specifically, an image of the main components ( Changes
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 as PR comments)
Additionally, you can add CodeRabbit Configration 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
Outside diff range and nitpick comments (1)
docs/learn/intro/03-sdk-design.md (1)
Line range hint
62-62
: Consider revising the punctuation and comma usage for better clarity.- Some core modules include: * `x/auth`: Used to manage accounts and signatures. - * `x/bank`: Used to enable tokens and token transfers. - to the already existing modules in `x/`, that anyone can use in their app, the Cosmos... + Some core modules include: `x/auth`, which is used to manage accounts and signatures; `x/bank`, which is used to enable tokens and token transfers. + In addition to the already existing modules in `x/` that anyone can use in their app, the Cosmos...Also applies to: 63-63, 66-66
Review details
Configuration used: .coderabbit.yml
Review profile: CHILL
Files ignored due to path filters (1)
docs/learn/intro/main-components.png
is excluded by!**/*.png
Files selected for processing (1)
- docs/learn/intro/03-sdk-design.md (1 hunks)
Additional context used
Path-based instructions (1)
docs/learn/intro/03-sdk-design.md (1)
Pattern
**/*.md
: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"
LanguageTool
docs/learn/intro/03-sdk-design.md
[uncategorized] ~62-~62: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: .... Some core modules include: *x/auth
: Used to manage accounts and signatures....
[uncategorized] ~63-~63: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...nage accounts and signatures. *x/bank
: Used to enable tokens and token transfe...
[typographical] ~66-~66: Make sure that the comma (,) is correct. Do not use a comma before a dependent clause that starts with ‘that’. (COMMA_THAT_NOUN)
Context: ... to the already existing modules inx/
, that anyone can use in their app, the Cosmos...
Additional comments not posted (4)
docs/learn/intro/03-sdk-design.md (4)
16-16
: The addition of the imagemain-components.png
enhances the visual understanding of the Cosmos SDK components. Ensure the image is properly linked and accessible.
17-17
: The explanation ofbaseapp
is clear and informative, providing a good understanding of its role within the Cosmos SDK.
17-17
: The section on Multistore is well-detailed, enhancing the reader's understanding of state management in Cosmos SDK applications.
Line range hint
1-66
: The document maintains a coherent structure and integrates the new content seamlessly, enhancing the overall clarity and usefulness of the documentation.
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.
could we get the diagram in mermaid? helps future contributors not need to change. the diagram looks way better than mermaid but better to be consistent
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.
there should be a way to make it similar to what you added as the image. Its a bit complicated
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.
graph
subgraph Main components of the sdk
B[baseapp]
subgraph Multistore
E[kvstore]
F[kvstore]
G[kvstore]
end
D[Modules]
end
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.
i cant get the arrow to work. and show up like this. its annoying
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.
Ill try give mermaid another go for this... Its so ugly but I know mermaid is way better for maintainability. Could we not have a couple of excalidraw ones in there for the higher level concepts that wont change?
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.
i mean yours also looks way better than mine
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.
Okay I tried this further and honestly I feel like we arent going to be able to use mermaid for all diagrams. I spend 30 mins trying to draw up a diagram and I could have remade it in excalidraw 3 times over. Im thinking we could just use both and include the excalidraw files maybe in the docs repo?
Added in the excalidraw 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
Review details
Configuration used: .coderabbit.yml
Review profile: CHILL
Files selected for processing (1)
- docs/learn/intro/Maincomps.excalidraw (1 hunks)
Additional comments not posted (1)
docs/learn/intro/Maincomps.excalidraw (1)
1-603
: The JSON structure of the Excalidraw file appears to be correctly formed and valid. The elements, such as rectangles, text, and arrows, are well-defined with appropriate properties likestrokeColor
,backgroundColor
,strokeWidth
, andopacity
. These properties ensure that the diagram is visually consistent and clear.
Description
Closes: #cosmos/cosmos-sdk-docs#153
Created a new diagram to highlight components, tried to use mermaid but its not as conducive to understanding the process as you can see below:
![Screenshot 2024-06-10 at 14 56 25](https://private-user-images.githubusercontent.com/37125168/338212838-5752c810-2be4-45ce-9e8b-f19c253b3223.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3Mzg5ODE1MTUsIm5iZiI6MTczODk4MTIxNSwicGF0aCI6Ii8zNzEyNTE2OC8zMzgyMTI4MzgtNTc1MmM4MTAtMmJlNC00NWNlLTllOGItZjE5YzI1M2IzMjIzLnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNTAyMDglMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjUwMjA4VDAyMjAxNVomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPTE4ZjMyMDBhZmExNWRlMjQ2ZGFiMzE5ODQwMTg4Y2UzNzA2NmU1YmJmOWFhZjM4ZWQ2MThhYTlmMGQ2YWExNTUmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0In0.PXAtQZZq_nu4vM4B9AhtslfJe9WHIg7zOd5zI3200RA)
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.md
Reviewers 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