chore: fix docs links #22931
chore: fix docs links #22931
Conversation
📝 WalkthroughWalkthroughThe pull request involves documentation updates for the Cosmos SDK, focusing on three key documents: module manager documentation, application anatomy, and SDK design. The changes primarily enhance clarity around terminology, particularly replacing "message and query routing" with "service routers". The documentation updates provide more detailed explanations of application components, initialization processes, and module interfaces, aiming to improve developer understanding of the SDK's architecture and functionality. Changes
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
🧹 Nitpick comments (1)
docs/build/building-modules/01-module-manager.md (1)
8-8: Improve readability by refining the wording.Consider these improvements:
- Replace "in order to" with "to"
- Replace "a variety of functions" with "functions"
-Cosmos SDK modules need to implement the [`AppModule` interfaces](#application-module-interfaces), in order to be managed by the application's [module manager](#module-manager). The module manager plays an important role in [`message` and `query` routing](../../learn/advanced/00-baseapp.md#service-routers), and allows application developers to set the order of execution of a variety of functions like [`PreBlocker`, `BeginBlocker` and `EndBlocker`](https://docs.cosmos.network/main/learn/beginner/app-anatomy). +Cosmos SDK modules need to implement the [`AppModule` interfaces](#application-module-interfaces) to be managed by the application's [module manager](#module-manager). The module manager plays an important role in [`message` and `query` routing](../../learn/advanced/00-baseapp.md#service-routers), and allows application developers to set the order of execution of functions like [`PreBlocker`, `BeginBlocker` and `EndBlocker`](https://docs.cosmos.network/main/learn/beginner/app-anatomy).🧰 Tools
🪛 LanguageTool
[style] ~8-~8: Consider a shorter alternative to avoid wordiness.
Context: ...faces](#application-module-interfaces), in order to be managed by the application's [module...(IN_ORDER_TO_PREMIUM)
[style] ~8-~8: The phrase “a variety of” may be wordy. To make your writing clearer, consider replacing it.
Context: ...lopers to set the order of execution of a variety of functions like [PreBlocker, `BeginBlo...(A_VARIETY_OF)
📜 Review details
Configuration used: .coderabbit.yml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
docs/build/building-modules/01-module-manager.md(1 hunks)docs/learn/beginner/00-app-anatomy.md(1 hunks)docs/learn/intro/03-sdk-design.md(1 hunks)
✅ Files skipped from review due to trivial changes (1)
- docs/learn/intro/03-sdk-design.md
🧰 Additional context used
📓 Path-based instructions (2)
docs/build/building-modules/01-module-manager.md (1)
Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"
docs/learn/beginner/00-app-anatomy.md (1)
Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"
🪛 LanguageTool
docs/build/building-modules/01-module-manager.md
[style] ~8-~8: Consider a shorter alternative to avoid wordiness.
Context: ...faces](#application-module-interfaces), in order to be managed by the application's [module...
(IN_ORDER_TO_PREMIUM)
[style] ~8-~8: The phrase “a variety of” may be wordy. To make your writing clearer, consider replacing it.
Context: ...lopers to set the order of execution of a variety of functions like [PreBlocker, `BeginBlo...
(A_VARIETY_OF)
🔇 Additional comments (1)
docs/learn/beginner/00-app-anatomy.md (1)
89-89: LGTM!
The documentation correctly references the updated terminology of "service routers" and provides clear explanations of the routing mechanisms.
julienrbrt
added
the
backport/v0.52.x
(cherry picked from commit 36a846c)
fixed a few references to re-named sections in BaseApp in docs
Summary by CodeRabbit
00-app-anatomy.mddocument for better understanding of Cosmos SDK application structure and functionality.03-sdk-design.mddocument to reflect changes in the description of theroutercomponent.