feat: add node snapshots page with providers #1906
Conversation
WalkthroughThis pull request introduces updates to the documentation. In the configuration file ( Changes
Possibly related PRs
Suggested labels
Suggested reviewers
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🧰 Additional context used🪛 LanguageToolhow-to-guides/consensus-node.md[misspelling] ~305-~305: The word “quick” is an adjective and doesn’t fit in this context. Did you mean the adverb “quickly”? (ADJECTIVE_ADVERB) 🔇 Additional comments (2)
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: 1
🧹 Nitpick comments (3)
how-to-guides/snapshots.md (3)
15-34: Comprehensive explanation of snapshot types.The distinction between pruned and archive snapshots is clearly explained, with good examples of when to use each type. This helps users make an informed decision based on their specific needs.
Consider adding some approximate size comparisons between pruned and archive snapshots to help users better understand the resource requirements.
🧰 Tools
🪛 LanguageTool
[style] ~21-~21: This wording could be more concise.
Context: ...or current operations, making them much smaller in size. These are ideal for: - Validator node...(ADJECTIVE_IN_ATTRIBUTE)
[duplication] ~23-~23: Possible typo: you repeated a word.
Context: ...nly need recent state to participate in consensus - Consensus nodes that don't need complete historic...(ENGLISH_WORD_REPEAT_RULE)
[grammar] ~24-~24: Did you mean “to complete”?
Context: ...ensus - Consensus nodes that don't need complete historical data - Users who want to get...(NEEDNT_TO_DO_AND_DONT_NEED_DO)
[style] ~29-~29: This wording could be more concise.
Context: ...ncluding all historical states. They're larger in size but provide access to the entire chain ...(ADJECTIVE_IN_ATTRIBUTE)
[style] ~32-~32: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ... data - Operating a consensus node that needs to support historical queries - Building a...(REP_NEED_TO_VB)
76-90: Installation instructions are clear and cover multiple platforms.The instructions provide pre-built binary options for different operating systems and architectures, as well as build-from-source steps.
Consider adding
chmod +xinstructions for the downloaded binaries to ensure they're executable.
91-133: Comprehensive usage examples for the snapshot-finder tool.The examples and flag descriptions are well-documented, covering both automatic and manual modes of operation.
Add a note about where the snapshot will be extracted and how to apply it to a node after downloading.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
.vitepress/config.ts(2 hunks)how-to-guides/consensus-node.md(3 hunks)how-to-guides/snapshots.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
how-to-guides/snapshots.md
[uncategorized] ~11-~11: You might be missing the article “the” here.
Context: ...t from a recent, verified state. Among various options for setting up your node, snaps...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[style] ~21-~21: This wording could be more concise.
Context: ...or current operations, making them much smaller in size. These are ideal for: - Validator node...
(ADJECTIVE_IN_ATTRIBUTE)
[duplication] ~23-~23: Possible typo: you repeated a word.
Context: ...nly need recent state to participate in consensus - Consensus nodes that don't need complete historic...
(ENGLISH_WORD_REPEAT_RULE)
[grammar] ~24-~24: Did you mean “to complete”?
Context: ...ensus - Consensus nodes that don't need complete historical data - Users who want to get...
(NEEDNT_TO_DO_AND_DONT_NEED_DO)
[style] ~29-~29: This wording could be more concise.
Context: ...ncluding all historical states. They're larger in size but provide access to the entire chain ...
(ADJECTIVE_IN_ATTRIBUTE)
[style] ~32-~32: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ... data - Operating a consensus node that needs to support historical queries - Building a...
(REP_NEED_TO_VB)
[grammar] ~74-~74: Possible subject-verb agreement error.
Context: ...Includes download progress tracking and resume capability ### Installation You can d...
(IS_AND_ARE)
how-to-guides/consensus-node.md
[misspelling] ~305-~305: The word “quick” is an adjective and doesn’t fit in this context. Did you mean the adverb “quickly”?
Context: ...ots.md) provides everything you need to quick sync your node: - Details about pruned...
(ADJECTIVE_ADVERB)
🔇 Additional comments (5)
.vitepress/config.ts (1)
535-536: Added a new sidebar entry for the Snapshots guide.Good addition of the Snapshots entry in the sidebar configuration. It's positioned appropriately under the Resources section, making it easy for users to discover.
how-to-guides/consensus-node.md (1)
303-311: Added clear navigation to the new snapshots guide.This tip block is well-placed within the "Quick sync" section, providing users with a clear reference to the dedicated snapshots guide. The content effectively summarizes what users will find in the linked guide.
🧰 Tools
🪛 LanguageTool
[misspelling] ~305-~305: The word “quick” is an adjective and doesn’t fit in this context. Did you mean the adverb “quickly”?
Context: ...ots.md) provides everything you need to quick sync your node: - Details about pruned...(ADJECTIVE_ADVERB)
how-to-guides/snapshots.md (3)
1-14: Well-structured introduction to node snapshots.The introduction clearly explains what node snapshots are and why they're beneficial for users setting up nodes. It establishes the purpose of the guide right away and highlights the time and resource savings.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~11-~11: You might be missing the article “the” here.
Context: ...t from a recent, verified state. Among various options for setting up your node, snaps...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
35-50: Well-organized listing of Mainnet Beta snapshot providers.The table format makes it easy to scan and find appropriate providers based on node type and snapshot preferences.
64-75: Excellent overview of celestia-snapshot-finder tool.The features section clearly communicates the benefits of using this tool for finding and downloading snapshots.
🧰 Tools
🪛 LanguageTool
[grammar] ~74-~74: Possible subject-verb agreement error.
Context: ...Includes download progress tracking and resume capability ### Installation You can d...(IS_AND_ARE)
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
how-to-guides/snapshots.md (3)
19-26: Suggestion to Streamline Pruned Snapshots Description
The explanation of pruned snapshots is informative. However, consider making the sentence in line 21 more concise. For example, instead of:"Pruned snapshots contain only the essential state needed to run a node. They exclude historical data that isn't necessary for current operations, making them much smaller in size."
you might condense it to:
"Pruned snapshots retain only the essential state for running a node, excluding redundant historical data and resulting in a smaller size."
Also, review the bullet for consensus nodes (line 24) to ensure the phrasing is consistent—if desired, align the terminology (e.g., "full historical data" vs. "complete historical data").🧰 Tools
🪛 LanguageTool
[style] ~21-~21: This wording could be more concise.
Context: ...or current operations, making them much smaller in size. These are ideal for: - Validator node...(ADJECTIVE_IN_ATTRIBUTE)
[duplication] ~23-~23: Possible typo: you repeated a word.
Context: ...nly need recent state to participate in consensus - Consensus nodes that don't need complete historic...(ENGLISH_WORD_REPEAT_RULE)
[grammar] ~24-~24: Did you mean “to complete”?
Context: ...ensus - Consensus nodes that don't need complete historical data - Users who want to get...(NEEDNT_TO_DO_AND_DONT_NEED_DO)
27-34: Refine Archive Snapshots Wording for Conciseness
The Archive Snapshots section is detailed and useful. To improve readability, consider rephrasing line 29 from:"Archive snapshots contain the complete blockchain history, including all historical states."
to something like:
"Archive snapshots store the full blockchain history, offering comprehensive access to past states."
Additionally, you might vary the phrasing in nearby sentences (e.g., line 32) to avoid repetition.🧰 Tools
🪛 LanguageTool
[style] ~29-~29: This wording could be more concise.
Context: ...ncluding all historical states. They're larger in size but provide access to the entire chain ...(ADJECTIVE_IN_ATTRIBUTE)
[style] ~32-~32: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ... data - Operating a consensus node that needs to support historical queries - Building a...(REP_NEED_TO_VB)
68-75: Enhance Parallelism in Features List
The bullet points under "Features" are informative. For improved parallelism, consider rewording the bullet on download progress tracking (line 74). For instance, change:"- Includes download progress tracking and resume capability"
to a variant such as:
"- Provides download progress tracking and supports resuming downloads"
This small adjustment helps maintain a uniform style throughout the list.🧰 Tools
🪛 LanguageTool
[grammar] ~74-~74: Possible subject-verb agreement error.
Context: ...Includes download progress tracking and resume capability ### Installation You can d...(IS_AND_ARE)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
how-to-guides/snapshots.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
how-to-guides/snapshots.md
[style] ~21-~21: This wording could be more concise.
Context: ...or current operations, making them much smaller in size. These are ideal for: - Validator node...
(ADJECTIVE_IN_ATTRIBUTE)
[duplication] ~23-~23: Possible typo: you repeated a word.
Context: ...nly need recent state to participate in consensus - Consensus nodes that don't need complete historic...
(ENGLISH_WORD_REPEAT_RULE)
[grammar] ~24-~24: Did you mean “to complete”?
Context: ...ensus - Consensus nodes that don't need complete historical data - Users who want to get...
(NEEDNT_TO_DO_AND_DONT_NEED_DO)
[style] ~29-~29: This wording could be more concise.
Context: ...ncluding all historical states. They're larger in size but provide access to the entire chain ...
(ADJECTIVE_IN_ATTRIBUTE)
[style] ~32-~32: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ... data - Operating a consensus node that needs to support historical queries - Building a...
(REP_NEED_TO_VB)
[grammar] ~74-~74: Possible subject-verb agreement error.
Context: ...Includes download progress tracking and resume capability ### Installation You can d...
(IS_AND_ARE)
🔇 Additional comments (13)
how-to-guides/snapshots.md (13)
1-3: Front Matter is Well-Formatted
The YAML front matter, including the description, is clear and properly delimited with---.
5-9: Clear Introduction to Node Snapshots
The "Node Snapshots" section and the explanation on what snapshots are use a clear analogy ("checkpoints") that immediately helps readers understand the concept.
11-14: Strong Explanation of Benefits
The content effectively highlights the benefits of using snapshots to save time and resources. The progression from introducing the concept to stating the advantages is logical and well-structured.
15-18: Effective Section Heading for Snapshot Types
The "Pruned vs Archive Snapshots" heading clearly differentiates the two types. This segmentation aids readability and helps users quickly locate the information they need.
35-50: Mainnet Beta Providers Table is Clear and Consistent
The table listing Mainnet Beta providers is well formatted. All provider links, including those for ITRocket, correctly reference the mainnet URLs.
51-63: Mocha Testnet Providers Table Uses Correct URLs
The Mocha Testnet table successfully updates URLs for ITRocket and the other providers to the testnet endpoints. This consistency addresses previous concerns from older commits.
64-67: Introduction to celestia-snapshot-finder is Concise
The section clearly introduces the snapshot finder tool, outlining its purpose and benefits, which will be very helpful for users who are new to the concept.
76-82: Installation Section is Clear and Actionable
The installation instructions, including the link to the pre-built binaries, are straightforward and well-structured, making it easy for users to get started.
83-90: Build-from-Source Instructions are Straightforward
The code block demonstrating how to build from source is clear and easy to follow. The step-by-step commands are helpful for users who prefer compiling the tool themselves.
91-100: Usage Examples are Well-Illustrated
The "Usage Examples" section with the corresponding command-line snippets provides clear guidance on how to use the tool. The examples cover both basic usage and flag-based customization effectively.
101-110: Examples Code Block is Informative
The examples provided further illustrate real-world usage scenarios for the snapshot finder tool, reinforcing the documentation's practical value.
111-120: Available Flags are Properly Listed
The code block listing the available flags is complete and clearly displays the command options, making it simple for users to understand the tool's functionality.
121-133: Detailed Mode Descriptions Enhance Usability
The step-by-step instructions for both automatic and manual modes are detailed and user-friendly, allowing operators to quickly grasp the workflow for each mode.
how-to-guides/snapshots.md
Outdated
| description: A guide to using node snapshots and snapshot providers for quick node setup, including how to use the celestia-snapshot-finder tool | ||
| --- | ||
|
|
||
| # Node Snapshots |
There was a problem hiding this comment.
| # Node Snapshots | |
| # Node snapshots |
how-to-guides/snapshots.md
Outdated
|
|
||
| # Node Snapshots | ||
|
|
||
| ## What are Node Snapshots? |
There was a problem hiding this comment.
| ## What are Node Snapshots? | |
| ## What are node snapshots? |
There was a problem hiding this comment.
please use sentence case on rest of doc for headings below! I tried to push but hit perms issues.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
how-to-guides/snapshots.md (4)
19-26: Refactor for Clarity in Pruned Snapshots DescriptionConsider revising the description for improved clarity and conciseness. For example:
-Pruned snapshots contain only the essential state needed to run a node. They exclude historical data that isn't necessary for current operations, making them much smaller in size. These are ideal for: +Pruned snapshots include only the essential state required for node operation, excluding non-essential historical data and resulting in a more compact snapshot. They are ideal for:🧰 Tools
🪛 LanguageTool
[style] ~21-~21: This wording could be more concise.
Context: ...or current operations, making them much smaller in size. These are ideal for: - Validator node...(ADJECTIVE_IN_ATTRIBUTE)
[duplication] ~23-~23: Possible typo: you repeated a word.
Context: ...nly need recent state to participate in consensus - Consensus nodes that don't need complete historic...(ENGLISH_WORD_REPEAT_RULE)
[grammar] ~24-~24: Did you mean “to complete”?
Context: ...ensus - Consensus nodes that don't need complete historical data - Users who want to get...(NEEDNT_TO_DO_AND_DONT_NEED_DO)
27-34: Streamline Archive Snapshots DescriptionThe explanation for archive snapshots could be made more concise by reducing repetitive phrasing. For example:
-Archive snapshots contain the complete blockchain history, including all historical states. They're larger in size but provide access to the entire chain history. You'll need an archive snapshot if you're: +Archive snapshots include the full blockchain history, offering access to all past states, though they are larger in size. You'll need an archive snapshot if:🧰 Tools
🪛 LanguageTool
[style] ~29-~29: This wording could be more concise.
Context: ...ncluding all historical states. They're larger in size but provide access to the entire chain ...(ADJECTIVE_IN_ATTRIBUTE)
[style] ~32-~32: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ... data - Operating a consensus node that needs to support historical queries - Building a...(REP_NEED_TO_VB)
68-75: Enhance Feature List ConsistencyThe feature list is informative. However, for the bullet on download tracking, consider adjusting for subject-verb and plural consistency. For example:
- - Includes download progress tracking and resume capability + - Includes download progress tracking and resume capabilities🧰 Tools
🪛 LanguageTool
[grammar] ~74-~74: Possible subject-verb agreement error.
Context: ...Includes download progress tracking and resume capability ### Installation You can d...(IS_AND_ARE)
127-133: Manual Mode Instructions and File ConsistencyThe manual mode steps are clearly listed. As a minor suggestion, please ensure that the file ends with a newline for POSIX compliance.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
how-to-guides/snapshots.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
how-to-guides/snapshots.md
[style] ~21-~21: This wording could be more concise.
Context: ...or current operations, making them much smaller in size. These are ideal for: - Validator node...
(ADJECTIVE_IN_ATTRIBUTE)
[duplication] ~23-~23: Possible typo: you repeated a word.
Context: ...nly need recent state to participate in consensus - Consensus nodes that don't need complete historic...
(ENGLISH_WORD_REPEAT_RULE)
[grammar] ~24-~24: Did you mean “to complete”?
Context: ...ensus - Consensus nodes that don't need complete historical data - Users who want to get...
(NEEDNT_TO_DO_AND_DONT_NEED_DO)
[style] ~29-~29: This wording could be more concise.
Context: ...ncluding all historical states. They're larger in size but provide access to the entire chain ...
(ADJECTIVE_IN_ATTRIBUTE)
[style] ~32-~32: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ... data - Operating a consensus node that needs to support historical queries - Building a...
(REP_NEED_TO_VB)
[grammar] ~74-~74: Possible subject-verb agreement error.
Context: ...Includes download progress tracking and resume capability ### Installation You can d...
(IS_AND_ARE)
🔇 Additional comments (13)
how-to-guides/snapshots.md (13)
1-3: Front Matter ValidityThe YAML front matter is correctly formatted and provides a clear description of the document.
5-7: Heading ConsistencyThe headings “# Node snapshots” and “## What are node snapshots?” are clear. Moving forward, ensure that heading styles (e.g., sentence case) remain consistent with the rest of the documentation as suggested in previous reviews.
9-13: Introduction ClarityThe introductory paragraphs clearly explain what node snapshots are and highlight their benefits. This context sets a solid foundation for the guide.
15-18: Snapshot Type IntroductionThe section introducing “Pruned vs archive snapshots” is concise and sets up the differentiation well.
35-50: Mainnet Beta Providers Table ReviewThe table for Mainnet beta providers is well-structured and clearly presents the available options. Please verify that all links remain current and accurate.
51-63: Mocha Testnet Providers Table ReviewThe Mocha testnet providers table correctly uses testnet URLs and reflects the updated ITRocket links from previous reviews.
64-66: Celestia-Snapshot-Finder IntroductionThe introduction to the
celestia-snapshot-findertool is clear and succinct, effectively setting expectations about its functionality.
76-82: Installation Instructions ClarityThe steps for downloading pre-built binaries and the subsequent binary names are clear and user-friendly.
83-90: Source Build InstructionsThe code block detailing the steps to build from source is clear and follows best practices.
91-100: Basic Usage ExampleThe basic usage example provided in the “Usage examples” section is concise and demonstrates command syntax effectively.
101-110: Detailed Examples ReviewThe examples clearly illustrate both pruned consensus and archive bridge node snapshot downloads, aiding users in understanding varied scenarios.
111-120: Flags Description VerificationThe available flags are comprehensively documented. It may be beneficial to verify that these flag descriptions align with the most recent version of the tool.
121-126: Automatic Mode DetailsThe description of the automatic mode is clear and logically structured.
TLDR: Added a dedicated snapshots page, documented verified providers, and introduced snapshot-finder tool for easier downloads.
This PR implements the discussed improvements around node snapshots:
Added a dedicated snapshots.md page that explains what snapshots are (pruned vs archive), lists snapshot providers for mainnet/testnet, and introduces the celestia-snapshot-finder tool for easier downloads. I've verified and only included snapshot providers that regularly update their snapshots and maintain fresh copies. Also added a tip note on the consensus-node page about snapshots page and updated the sidebar to include the new guide.
These changes make it easier for node operators to find and use fresh, working snapshots, significantly reducing the time needed to set up both consensus and DA layer nodes or access historical data blockchain state. Since I maintain the celestia-snapshots repo that the finder uses, I can keep this doc up to date and will be happy to add more providers as the list grows
Closes #1598 #1809
Summary by CodeRabbit
Documentation
Style