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

peggo-relayer.md #175

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

petryshkaCODE
Copy link

@petryshkaCODE petryshkaCODE commented Jan 24, 2025

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

  • Documentation
    • Fixed a typographical error in the Peggo relayer guide, correcting "settup" to "setup"

Copy link

coderabbitai bot commented Jan 24, 2025

Walkthrough

The 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

File Change Summary
guides/peggo-relayer.md Corrected typo: "settup" → "setup"

Poem

🐰 A Rabbit's Typo Tale 🔤

With whiskers twitching, keen and bright,
I spotted "settup" - oh, what a sight!
A letter misplaced, now fixed with care,
"Setup" emerges, pristine and fair.
Documentation's path, now clear and true! 📝


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

CodeRabbit Configuration 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

@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: 1

🧹 Nitpick comments (1)
guides/peggo-relayer.md (1)

5-5: Improve grammar and verb usage.

The sentence needs some grammatical improvements:

  1. Add the missing article "the"
  2. 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

📥 Commits

Reviewing files that changed from the base of the PR and between 0dbd5f0 and 2115618.

📒 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].
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

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.

Suggested change
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)

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.

1 participant