doc: fix link for proto-gen #22111
doc: fix link for proto-gen #22111
Conversation
GINMEL
requested review from
cool-develope,
kocubinski,
a team,
julienrbrt and
hieuvubk
as code owners
📝 WalkthroughWalkthroughThe pull request updates the documentation for the Changes
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 and nitpick comments (3)
store/streaming/abci/README.md (2)
Line range hint
30-36: LGTM! Enhanced instructions for code generation.The updated instructions provide clearer guidance for users working with different languages. The addition of the link to the proto README is particularly helpful.
Consider adding a comma after "For other languages" to improve readability:
-For other languages you'll need to [download](https://github.com/cosmos/cosmos-sdk/blob/main/proto/README.md#generate) +For other languages, you'll need to [download](https://github.com/cosmos/cosmos-sdk/blob/main/proto/README.md#generate)🧰 Tools
🪛 LanguageTool
[uncategorized] ~30-~30: Possible missing comma found.
Context: ...shell make proto-genFor other languages you'll need to [download](https://githu...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~31-~31: When ‘language-specific’ is used as a modifier, it is usually spelled with a hyphen.
Context: ...otos into your project and compile. For language specific compilation instructions visit [https:/...(SPECIFIC_HYPHEN)
Line range hint
137-153: LGTM! Enhanced configuration options.The updated configuration example provides more detailed options for users, including the ability to specify which keys to stream and whether to stop the node on errors. These additions offer greater flexibility and control.
Consider adding a brief explanation for the
stop-node-on-erroption to clarify its purpose:# stop-node-on-err specifies whether to stop the node when the +# streaming service encounters an error stop-node-on-err = true🧰 Tools
🪛 LanguageTool
[uncategorized] ~30-~30: Possible missing comma found.
Context: ...shell make proto-genFor other languages you'll need to [download](https://githu...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~31-~31: When ‘language-specific’ is used as a modifier, it is usually spelled with a hyphen.
Context: ...otos into your project and compile. For language specific compilation instructions visit [https:/...(SPECIFIC_HYPHEN)
server/v2/streaming/plugin.md (1)
32-32: Consider adding a comma for improved readability.To enhance clarity, consider adding a comma after the code block:
-```shell +```shell,This change will help separate the command from the subsequent instructions for other languages.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~32-~32: Possible missing comma found.
Context: ...shell make proto-genFor other languages you'll need to [download](https://githu...(AI_HYDRA_LEO_MISSING_COMMA)
📜 Review details
Configuration used: .coderabbit.yml
Review profile: CHILL
📒 Files selected for processing (2)
- server/v2/streaming/plugin.md (1 hunks)
- store/streaming/abci/README.md (1 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
server/v2/streaming/plugin.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"store/streaming/abci/README.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"
🪛 LanguageTool
server/v2/streaming/plugin.md
[uncategorized] ~32-~32: Possible missing comma found.
Context: ...shell make proto-genFor other languages you'll need to [download](https://githu...(AI_HYDRA_LEO_MISSING_COMMA)
store/streaming/abci/README.md
[uncategorized] ~30-~30: Possible missing comma found.
Context: ...shell make proto-genFor other languages you'll need to [download](https://githu...(AI_HYDRA_LEO_MISSING_COMMA)
🔇 Additional comments (5)
store/streaming/abci/README.md (2)
Line range hint
41-45: LGTM! Improved explanation of the plugin architecture.The added paragraph provides valuable context about the
ListenerGRPCPluginstruct and its relationship with theABCIListenerinterface. This addition enhances the overall understanding of the plugin architecture.🧰 Tools
🪛 LanguageTool
[uncategorized] ~30-~30: Possible missing comma found.
Context: ...shell make proto-genFor other languages you'll need to [download](https://githu...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~31-~31: When ‘language-specific’ is used as a modifier, it is usually spelled with a hyphen.
Context: ...otos into your project and compile. For language specific compilation instructions visit [https:/...(SPECIFIC_HYPHEN)
Line range hint
174-191: LGTM! Improved testing instructions and plugin system explanation.The updated testing instructions provide clearer guidance for exporting plugins and running tests. The added explanation of how the plugin system looks for the plugin binary enhances users' understanding of the process. These changes significantly improve the clarity of the testing documentation.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~30-~30: Possible missing comma found.
Context: ...shell make proto-genFor other languages you'll need to [download](https://githu...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~31-~31: When ‘language-specific’ is used as a modifier, it is usually spelled with a hyphen.
Context: ...otos into your project and compile. For language specific compilation instructions visit [https:/...(SPECIFIC_HYPHEN)
server/v2/streaming/plugin.md (3)
Line range hint
32-36: LGTM: Clear instructions and helpful resources provided.The added instructions for generating code in other languages are clear and informative. The inclusion of links to relevant resources and documentation is beneficial for users working with different programming languages.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~32-~32: Possible missing comma found.
Context: ...shell make proto-genFor other languages you'll need to [download](https://githu...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~33-~33: When ‘language-specific’ is used as a modifier, it is usually spelled with a hyphen.
Context: ...otos into your project and compile. For language specific compilation instructions visit [https:/...(SPECIFIC_HYPHEN)
Line range hint
32-79: Excellent documentation: Comprehensive explanation of gRPC implementation.The added content provides a detailed and well-structured explanation of the gRPC client and server implementation. The inclusion of code references and the explanation of the
ListenerGRPCPluginstruct are particularly helpful. This documentation significantly enhances the understanding of the implementation details for users.🧰 Tools
🪛 LanguageTool
[uncategorized] ~32-~32: Possible missing comma found.
Context: ...shell make proto-genFor other languages you'll need to [download](https://githu...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~33-~33: When ‘language-specific’ is used as a modifier, it is usually spelled with a hyphen.
Context: ...otos into your project and compile. For language specific compilation instructions visit [https:/...(SPECIFIC_HYPHEN)
Line range hint
32-79: Well-documented: Clear configuration instructions provided.The added configuration instructions for the
app.tomlfile are precise and easy to follow. The explanation of each streaming configuration option is helpful and well-formatted. This addition enhances the usability of the documentation for users setting up their environment.🧰 Tools
🪛 LanguageTool
[uncategorized] ~32-~32: Possible missing comma found.
Context: ...shell make proto-genFor other languages you'll need to [download](https://githu...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~33-~33: When ‘language-specific’ is used as a modifier, it is usually spelled with a hyphen.
Context: ...otos into your project and compile. For language specific compilation instructions visit [https:/...(SPECIFIC_HYPHEN)
refer to this
Summary by CodeRabbit
ABCIListenerinterface.ListenerGRPCPluginstruct.app.tomlsettings related to streaming.