docs: add quick state sync scripts #1725
Conversation
|
Warning Rate limit exceeded@jcstein has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 25 minutes and 2 seconds before requesting another review. How to resolve this issue?After the wait time has elapsed, a review can be triggered using the 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. WalkthroughThe pull request introduces a new section in the documentation for syncing a consensus node without requiring historical blocks. It provides specific scripts tailored for various environments, including Local devnet, Arabica, Mocha, and Mainnet Beta, all sourced from the Celestia GitHub repository. The section highlights the use of state sync for rapid synchronization to the latest block, while cautioning that these networks do not support access to historical blocks. Users are advised to verify the correct version and execute Changes
Possibly related PRs
Suggested labels
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 (
|
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range and nitpick comments (1)
nodes/consensus-node.md (1)
251-265: Excellent addition to the documentation!The tip box provides clear and concise guidance for users looking to quickly sync a consensus node without needing historical blocks. The inclusion of specific scripts for different environments and the link to the GitHub repository is very helpful.
The explanation of the public networks' use of state sync and the limitation of not having access to historical blocks is important for users to understand when making decisions based on their requirements.
The reminder to check out the correct version and run
make installbefore executing the scripts is a good practice to ensure a smooth experience.Consider rephrasing the sentence to avoid a split infinitive:
-If you are looking to quickly sync a consensus node, and do not need historical blocks, +If you are looking to sync a consensus node quickly, and do not need historical blocks,Tools
LanguageTool
[style] ~252-~252: Style-wise, it’s not ideal to insert an adverb (‘quickly’) in the middle of an infinitive construction (‘to sync’). Try moving the adverb to avoid split infinitives.
Context: ...e network topology. ::: tip If you are looking to quickly sync a consensus node, and do not need historical blocks, you...(SPLIT_INFINITIVE)
[style] ~260-~260: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ...se state sync so they'll get to the tip very quickly, but won't work for your use case if yo...(EN_WEAK_ADJECTIVE)
[grammar] ~263-~263: The word “checkout” is a noun. The verb is spelled with a white space.
Context: ...ou need historical blocks. Remember to checkout to the correct version and run `make in...(NOUN_VERB_CONFUSION)
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- nodes/consensus-node.md (1 hunks)
Additional context used
LanguageTool
nodes/consensus-node.md
[style] ~252-~252: Style-wise, it’s not ideal to insert an adverb (‘quickly’) in the middle of an infinitive construction (‘to sync’). Try moving the adverb to avoid split infinitives.
Context: ...e network topology. ::: tip If you are looking to quickly sync a consensus node, and do not need historical blocks, you...(SPLIT_INFINITIVE)
[style] ~260-~260: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ...se state sync so they'll get to the tip very quickly, but won't work for your use case if yo...(EN_WEAK_ADJECTIVE)
[grammar] ~263-~263: The word “checkout” is a noun. The verb is spelled with a white space.
Context: ...ou need historical blocks. Remember to checkout to the correct version and run `make in...(NOUN_VERB_CONFUSION)
Overview
Summary by CodeRabbit
New Features
Documentation