Skip to content

Eliminate extra section on operate #2339

Merged
jcstein merged 4 commits intodocs-glow-upfrom
gb/reorg-pages
Dec 12, 2025
Merged

Eliminate extra section on operate #2339
jcstein merged 4 commits intodocs-glow-upfrom
gb/reorg-pages

Conversation

@gbarros
Copy link
Copy Markdown
Contributor

@gbarros gbarros commented Dec 12, 2025

This pull request focuses on reorganizing and improving the developer documentation for Celestia, particularly around local devnet setup, navigation, and metadata structure. The main changes include updating the local devnet guide to use a tabbed interface for different setup methods, refactoring metadata and navigation for operator services, and making minor fixes to internal scripts and the Node API documentation.

Documentation improvements and restructuring:

  • The local devnet setup guide (local-devnet/page.mdx) has been rewritten to use a tabbed interface, making it easier to choose between Docker Compose and source-based setup. The instructions are now clearer, with dedicated sections for testing, stopping, and resetting the devnet, as well as guidance for multi-validator private networks. [1] [2]
  • The "IBC relayer setup" and "Audits" entries have been moved from optional-services/_meta.js to more appropriate locations in the metadata structure, and the obsolete testnet instantiation guide has been removed. [1] [2] [3] [4]
  • The "Optional operator services" entry has been removed from the operator metadata, reflecting the restructuring of documentation sections.

Node API and navigation updates:

  • The placeholder heading and selectors for the Node API Table of Contents have been updated from "Loading" to "Celestia Node API" to reflect the content better and improve integration with Nextra's TOC system. [1] [2] [3] [4] [5]
  • The Node API documentation now links to the appropriate GitHub release tag instead of the old RPC docs site.

Internal tooling fixes:

  • Minor improvements and bug fixes in the check-links.mjs script, including handling of case-insensitive redirects and simplifying function signatures. [1] [2] [3] [4]

- Introduced a new page for security audits conducted on Celestia software, detailing various audits and their respective reports.
- Updated metadata in _meta.js files to include new entries for audits and IBC relayer setup.
- Removed optional services metadata as it is no longer needed.
- Changed the hidden heading in DynamicRPCTOC from "## Loading" to "## Celestia Node API" to improve clarity.
- Updated the placeholder item selector in TOC_CONFIG to reflect the new heading.
- Modified the link in NodeAPIContent to point to the GitHub releases page instead of the previous documentation URL.
- Adjusted comments in DynamicRPCTOC to reference the new placeholder item.
- Removed unused parameters from the processFile function to streamline its usage.
- Updated the handling of redirects to improve clarity and maintainability.
- Enhanced error handling in the checkExternalLink function by omitting the error variable.
@gbarros gbarros requested a review from jcstein December 12, 2025 18:44
@gemini-code-assist
Copy link
Copy Markdown
Contributor

Summary of Changes

Hello @gbarros, 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 comprehensively reorganizes and enhances the developer documentation for Celestia, focusing on improving the clarity and accessibility of information related to local devnet setup, operator services, and the Node API. It also includes minor internal script adjustments to maintain documentation quality.

Highlights

  • Improved Local Devnet Documentation: The local devnet setup guide has been significantly revamped to use a tabbed interface, offering clearer instructions for both Docker Compose and source-based setups, including sections for testing, stopping, and resetting the devnet, and guidance for multi-validator private networks.
  • Documentation Restructuring and Navigation: Key documentation entries like "IBC relayer setup" and "Audits" have been moved to more logical locations within the metadata structure, and the "Optional operator services" entry has been removed, streamlining the overall navigation. An obsolete testnet instantiation guide was also removed.
  • Node API Documentation Enhancements: The Node API Table of Contents now correctly displays "Celestia Node API" instead of a "Loading" placeholder, and links to the appropriate GitHub release tags for better accuracy.
  • Internal Script Refinements: Minor bug fixes and improvements have been applied to the check-links.mjs script, enhancing its robustness, particularly in handling case-insensitive redirects and simplifying function signatures.
Using Gemini Code Assist

The 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 /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

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 .gemini/ folder in the base of the repository. Detailed instructions can be found here.

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

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request primarily focuses on documentation updates and reorganization. Key changes include renaming a placeholder heading for the dynamic Table of Contents from 'Loading' to 'Celestia Node API' across DynamicRPCTOC.tsx and node-api/page.mdx, and updating an external link for Node API documentation in NodeAPIContent.tsx to point to GitHub releases. The local devnet setup guide in local-devnet/page.mdx underwent a significant refactoring, now utilizing tabs to separate Docker Compose and script-based setup methods. New documentation pages for 'Audits' and 'IBC relayer setup' were added, along with their respective entries in _meta.js files, while an 'Optional operator services' entry and an 'instantiate-testnet' guide were removed. Minor code cleanups were also performed in the check-links.mjs script, such as removing unused variables and simplifying catch blocks.

Copy link
Copy Markdown
Member

@jcstein jcstein left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1 small change to audits table, otherwise LGTM

@jcstein jcstein merged commit da11b6c into docs-glow-up Dec 12, 2025
3 checks passed
@jcstein jcstein deleted the gb/reorg-pages branch December 12, 2025 18:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants