docs: document bridge node pruning and archival mode - #2402
Conversation
Add comprehensive documentation updates for upcoming bridge node changes: - Document new default pruning mode for bridge nodes (PR #4768) - Add --archival flag documentation for full historical data retention - Include routing exchange optimization notes (PR #4758) - Update hardware requirements to clarify pruned vs archival modes - Add migration guide for existing bridge node operators - Update custom networks docs with genesis hash requirements - Add breaking change warnings across all relevant pages Note: Version placeholders (TODO) added pending release of PR #4768 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
Summary of ChangesHello @jcstein, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request updates the Celestia documentation to reflect significant changes in bridge node behavior, primarily the shift to default pruning mode and the introduction of an explicit archival mode. It provides crucial information for operators on how to manage their nodes, including a migration guide and specific considerations for private networks. The updates aim to clarify the new operational paradigms and ensure users can configure their bridge nodes appropriately for their specific needs, whether for reduced storage or full historical data access. Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Changelog
Activity
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
Code Review
This pull request provides comprehensive and much-needed documentation for the recent changes to bridge node pruning. The explanations of pruned vs. archival modes, the new --archival flag, and the migration guide are clear and well-structured. The changes are consistently applied across all relevant documentation files, which will be very helpful for users.
I've left a few minor suggestions to improve clarity and consistency in the configuration reference and custom networks documentation. Overall, this is an excellent documentation update.
|
🚀 Preview Deployment Your preview is ready: https://celestiaorg.github.io/docs-preview/pr-2402/ |
* Initial plan * fix: replace broken external link in data availability docs Co-authored-by: jcstein <46639943+jcstein@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: jcstein <46639943+jcstein@users.noreply.github.com>
* Initial plan * Remove dead BlackBlocks links from snapshots documentation Co-authored-by: jcstein <46639943+jcstein@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: jcstein <46639943+jcstein@users.noreply.github.com>
* feat: add LLM-ready markdown export feature Implements automatic generation of clean markdown files from MDX sources, making the docs easily consumable by LLMs and other tools. Users can now append .md to any documentation URL to get a clean markdown version. Changes: - Enhanced generate-llms.js to create individual .md files for each .mdx page - Integrated markdown generation into the build process via postbuild hook - Added cleanMdxContent function to strip JSX, imports, and MDX-specific syntax - Smart output directory selection (out/ for builds, public/ for dev) - Updated README with feature documentation Example usage: https://docs.celestia.org/learn/TIA/overview.md 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com> * fix: properly replace variables in markdown export for LLMs - Add variable resolution from constants JSON files - Handle both single-brace and double-brace variable formats - Support bracket and dot notation for object properties - Fix regex for page.md replacement to avoid edge cases - Remove frontmatter from exported markdown (not standard markdown) - Eliminate duplicate outputBase determination logic Variables like {arabicaVersions['node-latest-tag']} and {{constants['arabicaChainId']}} are now properly replaced with their actual values in the exported .md files --------- Co-authored-by: Claude <noreply@anthropic.com>
- Add copyable code block with essential documentation access info - Organize LLM support section with subsections for clarity - Make it easy for developers to share access info with their agents
- Fixed confusing description that incorrectly implied 0 was default for non-archival nodes - Clarified that 0 disables pruning (archival mode) - Added note about typical default window for non-archival nodes
| - Required if you need to serve data to light nodes for blocks outside the availability window | ||
|
|
||
| <Callout type="info"> | ||
| **Routing Exchange Optimization**: Bridge nodes automatically optimize header synchronization using a routing exchange mechanism. Requests within the data availability window are routed to the core exchange for complete blocks, while requests outside the window are routed to the P2P exchange for headers only. This optimization happens automatically without any configuration needed. |
There was a problem hiding this comment.
before merging, review if this is necessary
- Removed premature migration instructions for unreleased feature - Will add proper guidance once PR #4768 is released with version info - Avoids confusion with untested migration steps
- Added tabs component to show pruned (default) vs archival mode options - Cleaner presentation that reduces repetition in documentation - Makes it clear which mode is the default behavior
* docs: update AWS KMS guide for op-alt-da v0.12.0 - Update guide to use v0.12.0+ which changes KMS configuration - Remove cel-key workflow (no longer needed for key import) - Remove deprecated config fields: alias_prefix, auto_create, import_key_name, import_key_hex - Add new workflow: create KMS key directly via AWS CLI - Update default_key_name to use full alias path format - Use "POST and get error" approach to discover Celestia address - Fix curl commands to suppress binary output warnings (-s -o /dev/null) - Add IAM policy and production setup instructions Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * docs: suggestions from review --------- Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
* docs: remove BNs from DFP * docs: make explicit on running both testnet and mainnet
…#2418) * docs: add Hibiscus (v7) upgrade and move Matcha (v6) to past upgrades Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * docs: add Arabica v7 upgrade timestamp Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
* Initial plan * Add ONLY_FAIL_ON_404_PATTERNS to handle nodestake URL - Created new ONLY_FAIL_ON_404_PATTERNS array for URLs that should only fail on 404s - Added explorer.nodestake.top/celestia to this pattern list - Modified checkExternalLink to accept and handle onlyFailOn404Patterns parameter - URLs matching these patterns will be treated as valid (skipped) unless they return a 404 status code - Other errors like timeouts, connection failures, etc. are now ignored for these URLs Co-authored-by: jcstein <46639943+jcstein@users.noreply.github.com> * Optimize pattern matching with Array.some() Applied code review feedback to use Array.some() for more efficient pattern matching instead of a for loop with break statement. Co-authored-by: jcstein <46639943+jcstein@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: jcstein <46639943+jcstein@users.noreply.github.com>
* docs: add Mocha v7 activation height * docs: normalize Hibiscus upgrade table formatting * fix: lint * docs: set Mocha v7 activation timestamp
[GH Action] Update release tags and commit SHAs for arabica
Stabilize link-check by treating Etherscan address pages as 404-only failures
…-endpoints-job Fix endpoint-check workflow output delimiter parsing
[GH Action] Update release tags and commit SHAs for arabica
[GH Action] Update release tags and commit SHAs for mocha
[GH Action] Update release tags and commit SHAs for mainnet
…_and_yarn-0213aa4daa chore(deps): bump dompurify from 3.4.3 to 3.4.10 in the npm_and_yarn group across 1 directory
…dates Bumps the npm_and_yarn group with 6 updates in the / directory: | Package | From | To | | --- | --- | --- | | [axios](https://github.com/axios/axios) | `1.16.0` | `1.18.0` | | [next](https://github.com/vercel/next.js) | `16.2.6` | `16.2.11` | | [@babel/core](https://github.com/babel/babel/tree/HEAD/packages/babel-core) | `7.28.5` | `7.29.7` | | [dompurify](https://github.com/cure53/DOMPurify) | `3.4.10` | `3.4.12` | | [form-data](https://github.com/form-data/form-data) | `4.0.5` | `4.0.6` | | [js-yaml](https://github.com/nodeca/js-yaml) | `4.1.1` | `4.3.0` | Updates `axios` from 1.16.0 to 1.18.0 - [Release notes](https://github.com/axios/axios/releases) - [Changelog](https://github.com/axios/axios/blob/v1.x/CHANGELOG.md) - [Commits](axios/axios@v1.16.0...v1.18.0) Updates `next` from 16.2.6 to 16.2.11 - [Release notes](https://github.com/vercel/next.js/releases) - [Commits](vercel/next.js@v16.2.6...v16.2.11) Updates `@babel/core` from 7.28.5 to 7.29.7 - [Release notes](https://github.com/babel/babel/releases) - [Changelog](https://github.com/babel/babel/blob/main/CHANGELOG.md) - [Commits](https://github.com/babel/babel/commits/v7.29.7/packages/babel-core) Updates `dompurify` from 3.4.10 to 3.4.12 - [Release notes](https://github.com/cure53/DOMPurify/releases) - [Commits](cure53/DOMPurify@3.4.10...3.4.12) Updates `form-data` from 4.0.5 to 4.0.6 - [Changelog](https://github.com/form-data/form-data/blob/master/CHANGELOG.md) - [Commits](form-data/form-data@v4.0.5...v4.0.6) Updates `js-yaml` from 4.1.1 to 4.3.0 - [Changelog](https://github.com/nodeca/js-yaml/blob/master/CHANGELOG.md) - [Commits](nodeca/js-yaml@4.1.1...4.3.0) --- updated-dependencies: - dependency-name: axios dependency-version: 1.18.0 dependency-type: direct:production dependency-group: npm_and_yarn - dependency-name: next dependency-version: 16.2.11 dependency-type: direct:production dependency-group: npm_and_yarn - dependency-name: "@babel/core" dependency-version: 7.29.7 dependency-type: indirect dependency-group: npm_and_yarn - dependency-name: dompurify dependency-version: 3.4.12 dependency-type: indirect dependency-group: npm_and_yarn - dependency-name: form-data dependency-version: 4.0.6 dependency-type: indirect dependency-group: npm_and_yarn - dependency-name: js-yaml dependency-version: 4.3.0 dependency-type: indirect dependency-group: npm_and_yarn ... Signed-off-by: dependabot[bot] <support@github.com>
The _page._mdx file was renamed away from page.mdx during the Operate migration and never rendered. Drop it, stop treating it as a route in the link checker, and point the leftover /operate link at the IBC relayer docs. Co-authored-by: Cursor <cursoragent@cursor.com>
…an-page Remove unused Operate section stub page
…_and_yarn-e2394bf4d9 chore(deps): bump the npm_and_yarn group across 1 directory with 6 updates
Fix flaky link checks
…' into jcstein/review-pr-2402-relevance
Overview
Documents the bridge-node pruning and routing changes introduced by:
These changes have shipped across Arabica, Mocha, and Mainnet Beta. This refresh
rebases the original draft onto current
mainand describes the currentcelestia-node behavior without release placeholders.
Changes
--archivalas a start-time option that must be supplied on everystart.
archival mode.
[Header.Syncer]configuration fields and defaultPruningWindow.retrieve older headers and data from P2P.
endpoint requirement.
Validation
yarn lint(passes with one pre-existing warning inapp/build/rpc/components/NodeAPIContent.tsx)yarn buildguidance
notes