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

docs(setup): validator instructions #2407

Merged
merged 7 commits into from
Jan 30, 2024
Merged

Conversation

robert-zaremba
Copy link
Member

@robert-zaremba robert-zaremba commented Jan 29, 2024

Description

Adding instructions about setting up validator nodes.

Summary by CodeRabbit

  • Documentation
    • Added a new "Validators" section with a link to detailed validator instructions.
    • Updated the testnet name from "canon-3" to "canon-4" in the documentation.
    • Introduced comprehensive guidelines for joining a testnet or mainnet as a validator.

Copy link
Contributor

coderabbitai bot commented Jan 29, 2024

Warning

Rate Limit Exceeded

@robert-zaremba has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 28 minutes and 37 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.
Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.
Please see our FAQ for further information.

Commits Files that changed from the base of the PR and between b3097ff and 772c65d.

Walkthrough

The project documentation has been updated to include a new section for "Validators," providing essential guidance for those interested in becoming validators on either a testnet or mainnet. Additionally, there's an update to the testnet name, transitioning from "canon-3" to "canon-4" under the "Public" section, reflecting a step forward in the network's evolution.

Changes

File Change Summary
README.md - Added "Validators" section
- Updated testnet name from "canon-3" to "canon-4"
VALIDATOR.md - Comprehensive documentation for validators on joining testnet or mainnet

🐇✨
In the land of code and net,
A new path for validators set.
From "canon-3" to "canon-4", we hop,
Ensuring our blockchain never stops.
🌟🐾

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>.
    • Generate unit-tests for this file.
  • 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 tests 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 generate interesting stats about this repository from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

Copy link
Contributor

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

Review Status

Actionable comments generated: 6

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 57cc33d and 577e1f5.
Files selected for processing (2)
  • README.md (3 hunks)
  • VALIDATOR.md (1 hunks)
Additional comments: 2
README.md (2)
  • 198-198: Correctness of documentation link.

Verify that the link to VALIDATOR.md is correctly relative to the README.md location in the repository structure.

  • 87-87: Update reflects the latest testnet version.

The update from "canon-3" to "canon-4" accurately reflects the new testnet version.

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Copy link
Contributor

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

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 577e1f5 and f38c234.
Files selected for processing (1)
  • VALIDATOR.md (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • VALIDATOR.md

@gsk967
Copy link
Collaborator

gsk967 commented Jan 29, 2024

@robert-zaremba Can you add canon-4 grpc,lcd and explore endpoints to testnet section

Copy link
Contributor

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

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between f38c234 and b3097ff.
Files selected for processing (1)
  • VALIDATOR.md (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • VALIDATOR.md

@robert-zaremba robert-zaremba added this pull request to the merge queue Jan 30, 2024
Merged via the queue into main with commit f9ac6dc Jan 30, 2024
20 of 21 checks passed
@robert-zaremba robert-zaremba deleted the robert/validator-docs branch January 30, 2024 15:55
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.

3 participants