Typos

[romashka-btc]

Fix: Corrected typos in documentation

What was changed

1. Corrected typo particpants to participants in docs\architecture\adr-033-protobuf-inter-module-comm.md (line 381).
2. Corrected typo Embeing to Embedding in docs\learn\beginner\00-app-anatomy.md (line 62).

Why these changes were made

• Fixing typos enhances the clarity, readability, and professionalism of the documentation.
• Accurate and professional documentation ensures better understanding and usability for readers.

Additional Notes

• These changes focus solely on correcting typographical errors in the documentation and do not affect the functionality of the code.

Summary by CodeRabbit

• Documentation
  • Updated the architecture document to introduce a new framework for inter-module communication using Protocol Buffers, emphasizing security and stability.
  • Enhanced the beginner's guide with formatting improvements, clarifications on lifecycle methods, and additional resources for better understanding of Cosmos SDK applications.

[coderabbitai]

📝 Walkthrough

Walkthrough

The pull request introduces a comprehensive update to the Cosmos SDK's inter-module communication architecture, focusing on a new framework using Protocol Buffers. The key innovation is the "Keeper" paradigm, which replaces existing keeper interfaces with generated QueryClient and MsgClient interfaces. A new ModuleKey concept is introduced to enhance security through object capabilities (OCAPs), allowing modules to securely interact and derive sub-account keys. The changes aim to provide a more stable, secure, and flexible approach to module interactions while maintaining backward compatibility.

Changes

File	Change Summary
docs/architecture/adr-033-protobuf-inter-module-comm.md	Comprehensive update to inter-module communication architecture, introducing new ModuleKey, ModuleID, and communication paradigms
docs/learn/beginner/00-app-anatomy.md	Formatting improvements, corrected typo from "Embeding" to "Embedding", enhanced explanations of application lifecycle methods

Sequence Diagram

sequenceDiagram
    participant ModuleA
    participant ModuleKey
    participant ModuleB
    
    ModuleA->>ModuleKey: Derive Sub-Account Key
    ModuleKey-->>ModuleA: Return Derived Key
    ModuleA->>ModuleB: Invoke Method with Derived Key
    ModuleB-->>ModuleA: Process and Respond

Loading

Possibly Related PRs

• docs: update go module link #22037: Updates to Go modules documentation
• docs: update learn/intro #22046: Documentation clarifications on module interactions
• docs: update protobuf links #22182: Protocol Buffers documentation link updates
• docs: update learn/beginner docs #22191: Beginner documentation updates on Msg services and lifecycle methods
• docs: rewrite building module section (1/n) - mm #22724: Rewriting module building documentation
• docs: rewrite building module section (2/n) -- env + core services #22790: Documentation on module environment and core services
• docs: runtime docs #22816: Runtime documentation improvements

---

📜 Recent review details

Configuration used: .coderabbit.yml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 234cdc4 and 0570f38.

📒 Files selected for processing (2)

• docs/architecture/adr-033-protobuf-inter-module-comm.md (1 hunks)
• docs/learn/beginner/00-app-anatomy.md (1 hunks)

🧰 Additional context used

📓 Path-based instructions (2)

docs/learn/beginner/00-app-anatomy.md (1)

Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"

docs/architecture/adr-033-protobuf-inter-module-comm.md (1)

Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"

🔇 Additional comments (2)

docs/architecture/adr-033-protobuf-inter-module-comm.md (1)

381-381: LGTM! Typo fix: "particpants" → "participants"

The correction improves readability while maintaining the technical accuracy of the documentation.

docs/learn/beginner/00-app-anatomy.md (1)

62-62: LGTM! Typo fix: "Embeing" → "Embedding"

The correction improves technical accuracy by using the proper Go terminology for type embedding.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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>, please review it.
  • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @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 using 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 generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

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.

[julienrbrt]

Note 2: At this time, we will not be accepting contributions that only fix spelling or grammar errors in documentation, code or elsewhere. The repository has a nightly job that spell checks all files and will automatically open PRs for any spelling errors.

https://github.com/cosmos/cosmos-sdk/blob/main/CONTRIBUTING.md