docs icon indicating copy to clipboard operation
docs copied to clipboard
verified publisher icon celestiaorg

docs: add clarity to statesync

Open jcstein opened this issue 9 months ago • 2 comments

Overview

Statesync section needs more clarity around what the user needs to set. From what was written (and from not reading closely enough), I thought I didn't need to set up RPCs.

Summary by CodeRabbit

  • Documentation
    • Improved instructions and formatting for setting up state sync in consensus node configuration.
    • Added warning and tip blocks to emphasize the need for at least two RPC endpoints.
    • Updated example configuration with clearer guidance and placeholder endpoints.

jcstein avatar Mar 28 '25 23:03 jcstein

Walkthrough

The documentation for configuring state sync in the consensus node was revised to improve clarity and readability. Additional explanations and formatting were introduced, including warning and tip blocks to emphasize the requirement for multiple RPC endpoints. The example configuration for rpc_servers was updated with placeholders and clearer instructions. No changes were made to the underlying configuration parameters or any code.

Changes

File(s) Change Summary
how-to-guides/consensus-node.md Enhanced documentation for state sync setup: added warnings, tips, improved formatting, and updated example configuration.

Possibly related PRs

  • celestiaorg/docs#1652: Adds a new configuration option to explicitly enable state sync, complementing the improved documentation on state sync configuration.

Suggested reviewers

  • rootulp

Poem

In docs where sync and states align,
New warnings and tips now brightly shine.
Placeholders guide you, clear and neat,
Two RPCs—your setup’s complete!
With every hop and every note,
The consensus node learns what we wrote.
🐇✨

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

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.

coderabbitai[bot] avatar Mar 28 '25 23:03 coderabbitai[bot]

PR Preview Action v1.6.0 :---: |

:rocket: View preview at
https://celestiaorg.github.io/docs-preview/pr-1958/

|
Built to branch main at 2025-03-28 23:14 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

github-actions[bot] avatar Mar 28 '25 23:03 github-actions[bot]