Skip to content
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

Merged
merged 6 commits into from
Jun 20, 2024

Conversation

samricotta
Copy link
Contributor

@samricotta samricotta commented Jun 10, 2024

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


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...

  • included the correct type prefix in the PR title, you can find examples of the prefixes below:
  • confirmed ! in the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • reviewed "Files changed" and left comments if necessary
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • updated the relevant documentation or specification, including comments for documenting Go code
  • confirmed all CI checks have passed

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...

  • confirmed the correct type prefix in the PR title
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

Summary by CodeRabbit

  • Documentation
    • Added an image illustrating main components in the Cosmos SDK application.
    • Included a new visual representation using Excalidraw to showcase the relationships between main components.

@samricotta samricotta requested a review from a team as a code owner June 10, 2024 13:47
Copy link
Contributor

coderabbitai bot commented Jun 10, 2024

Walkthrough

The update introduces visual aids in the documentation of the Cosmos SDK. Specifically, an image of the main components (main-components.png) is added, and a new Excalidraw file (Maincomps.excalidraw) depicts these components and their relationships. No changes were made to the codebase or public API.

Changes

File Path Change Summary
docs/learn/intro/03-sdk-design.md Added an image (main-components.png) illustrating main components and descriptions.
docs/learn/intro/Maincomps.excalidraw Introduced a visual representation of the SDK’s main components using Excalidraw.

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?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a 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

Commits

Files that changed from the base of the PR and between 7fb2668 and aa8f94e.

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 in x/, 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 image main-components.png enhances the visual understanding of the Cosmos SDK components. Ensure the image is properly linked and accessible.


17-17: The explanation of baseapp 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.

Copy link
Member

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

Copy link
Member

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

Copy link
Member

@tac0turtle tac0turtle Jun 11, 2024

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
Loading

Copy link
Member

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

Copy link
Contributor Author

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?

Copy link
Contributor Author

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

Copy link
Contributor Author

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?

@samricotta
Copy link
Contributor Author

Added in the excalidraw file

Copy link
Contributor

@coderabbitai coderabbitai bot left a 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

Commits

Files that changed from the base of the PR and between aa8f94e and 2cac4d6.

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 like strokeColor, backgroundColor, strokeWidth, and opacity. These properties ensure that the diagram is visually consistent and clear.

@samricotta samricotta enabled auto-merge June 20, 2024 14:22
@samricotta samricotta added this pull request to the merge queue Jun 20, 2024
Merged via the queue into main with commit 9983bde Jun 20, 2024
62 of 63 checks passed
@samricotta samricotta deleted the sam/components branch June 20, 2024 14:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants