-
Notifications
You must be signed in to change notification settings - Fork 29
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
peggo-relayer.md #175
base: master
Are you sure you want to change the base?
peggo-relayer.md #175
Conversation
WalkthroughThe pull request involves a minor documentation correction in the Peggo relayer guide. A typographical error for the word "setup" was fixed, improving the readability and accuracy of the markdown documentation. This change is purely textual and does not impact any technical functionality of the system. Changes
Poem
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
CodeRabbit Configuration 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: 1
🧹 Nitpick comments (1)
guides/peggo-relayer.md (1)
5-5
: Improve grammar and verb usage.The sentence needs some grammatical improvements:
- Add the missing article "the"
- Use "set up" (two words) when used as a verb
-Follow official guide to setup [peggo on testnet][peggo-testnet-link] or setup [peggo for mainnet][peggo-mainet-link]. +Follow the official guide to set up [peggo on testnet][peggo-testnet-link] or set up [peggo for mainnet][peggo-mainnet-link].🧰 Tools
🪛 LanguageTool
[uncategorized] ~5-~5: You might be missing the article “the” here.
Context: ...trator for the Injective Chain. Follow official guide to setup [peggo on testnet][peggo...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
🪛 Markdownlint (0.37.0)
5-5: Missing link or image reference definition: "peggo-mainet-link"
Reference links and images should use a label that is defined(MD052, reference-links-images)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
guides/peggo-relayer.md
(1 hunks)
🧰 Additional context used
🪛 LanguageTool
guides/peggo-relayer.md
[uncategorized] ~5-~5: You might be missing the article “the” here.
Context: ...trator for the Injective Chain. Follow official guide to setup [peggo on testnet][peggo...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
🪛 Markdownlint (0.37.0)
guides/peggo-relayer.md
5-5: Missing link or image reference definition: "peggo-mainet-link"
Reference links and images should use a label that is defined
(MD052, reference-links-images)
@@ -2,7 +2,7 @@ | |||
|
|||
Peggo is a Go implementation of the Peggy Orchestrator for the Injective Chain. | |||
|
|||
Follow official guide to setup [peggo on testnet][peggo-testnet-link] or settup [peggo for mainnet][peggo-mainet-link]. | |||
Follow official guide to setup [peggo on testnet][peggo-testnet-link] or setup [peggo for mainnet][peggo-mainet-link]. |
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.
Fix the broken reference link.
There's a typo in the reference link ID - "mainet" should be "mainnet".
-[peggo-mainet-link]
+[peggo-mainnet-link]
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Follow official guide to setup [peggo on testnet][peggo-testnet-link] or setup [peggo for mainnet][peggo-mainet-link]. | |
Follow official guide to setup [peggo on testnet][peggo-testnet-link] or setup [peggo for mainnet][peggo-mainnet-link]. |
🧰 Tools
🪛 LanguageTool
[uncategorized] ~5-~5: You might be missing the article “the” here.
Context: ...trator for the Injective Chain. Follow official guide to setup [peggo on testnet][peggo...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
🪛 Markdownlint (0.37.0)
5-5: Missing link or image reference definition: "peggo-mainet-link"
Reference links and images should use a label that is defined
(MD052, reference-links-images)
This pull request fixes the typo "settup" to "setup" in the peggo-relayer.md file to ensure correct spelling and improve the documentation.
Summary by CodeRabbit