docs: sync mode table

[rootulp]

Follow up to #1662

Summary by CodeRabbit

• New Features
  • Introduced a detailed section on synchronization modes for consensus nodes.
    • Described three sync types: Block sync, State sync, and Quick sync, with estimated completion times and descriptions.
• Documentation
  • Enhanced clarity in instructions regarding the configuration of RPC endpoints through minor formatting changes.

[coderabbitai]

Walkthrough

The recent updates enhance the documentation for consensus nodes by introducing a detailed section on synchronization modes, clarifying operational parameters, and improving readability. The new modes—Block sync, State sync, and Quick sync—are explained with estimated completion times, aiding users in selecting the best approach for their needs. Additionally, minor formatting adjustments ensure clearer instructions, contributing to a more user-friendly experience.

Changes

File	Change Summary
nodes/consensus-node.md	Added section on synchronization modes (Block sync, State sync, Quick sync) with time estimates and functionality descriptions. Minor formatting changes for clarity.

Possibly related issues

• Ideas for full-consensus-node page #1640: The changes in this PR address the need to provide time estimates for synchronization options, as well as clarifying the functionality of sync modes mentioned in the issue.

Poem

🐇 In the land where nodes align,
A sync of blocks, oh how they shine!
With time to spare, we hop along,
Quick, State, or Block, we can't go wrong.
So let’s cheer for the changes made,
A smoother path for every upgrade! 🥕✨

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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 as 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 resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

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

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.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 7db1c97 and 14f98f1.

Files selected for processing (1)

• nodes/consensus-node.md (2 hunks)

Additional comments not posted (4)

nodes/consensus-node.md (4)

203-207: LGTM! The sync types table is clear and informative.

The descriptions for Block sync, State sync, and Quick sync are accurate and provide useful information regarding their estimated completion times and functionalities.

---

Line range hint 209-211:
LGTM! The Block sync section is well-explained.

The description accurately explains the default sync method, its security, and time requirements.

---

Line range hint 213-243:
LGTM! The State sync section is clear and provides detailed instructions.

The description accurately explains the State sync method, its reliance on weak subjectivity, and provides clear instructions for configuration.

---

Line range hint 245-265:
LGTM! The Quick sync section is clear and provides detailed instructions.

The description accurately explains the Quick sync method and provides clear instructions for downloading and extracting the data directory.

[jcstein]

\ (__/)
(•ㅅ•)
/ 　 づ ⏯️