Skip to content

Migration of old docs content for Operate Section #2325

Merged
jcstein merged 9 commits intodocs-glow-upfrom
gb/new-operate
Dec 5, 2025
Merged

Migration of old docs content for Operate Section #2325
jcstein merged 9 commits intodocs-glow-upfrom
gb/new-operate

Conversation

@gbarros
Copy link
Copy Markdown
Contributor

@gbarros gbarros commented Dec 4, 2025

This pull request adds significant improvements and new content to the operator documentation for consensus validators and related topics. The changes introduce new guides, CLI command references, monitoring and metrics instructions, and explain slashing/jailing mechanics. Additionally, metadata files are added for improved navigation and organization.

Content Additions and Improvements

  • Added a comprehensive guide for installing celestia-app, including instructions for building from source, installing pre-built binaries, supported architectures, and required ports. (app/operate/consensus-validators/install-celestia-app/page.mdx)
  • Introduced a detailed CLI command reference for celestia-appd, covering wallet creation, key management, token operations, governance, validator rewards, delegation, unjailing, log export, and genesis signing. (app/operate/consensus-validators/cli-reference/page.mdx)
  • Added a metrics and monitoring guide, including Prometheus/Grafana setup, node exporter, and alerting instructions for validator operators. (app/operate/consensus-validators/metrics/page.mdx)
  • Provided a clear explanation of jailing and slashing mechanics for validators, detailing conditions and consequences. (app/operate/consensus-validators/slashing/page.mdx)
  • Added documentation for upgrade monitoring using the upgrade-monitor tool. (app/operate/consensus-validators/upgrade-monitor/page.mdx)

Navigation and Organization

  • Added _meta.js files to organize and provide display names for sidebar navigation in operate, consensus-validators, and data-availability sections. (app/operate/_meta.js, app/operate/consensus-validators/_meta.js, app/operate/data-availability/_meta.js) [1] [2] [3]
  • Renamed app/operate/page.mdx to _page._mdx and removed the landingPage frontmatter for consistency.

@gbarros gbarros requested a review from jcstein December 4, 2025 21:17
@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 significantly enhances the operator documentation for the Celestia network. It integrates a wealth of new content and guides aimed at providing comprehensive resources for setting up, managing, and troubleshooting both consensus validators and data availability nodes. The changes improve the clarity and accessibility of information for all types of network participants, from installation to advanced operational configurations.

Highlights

  • New Operator Documentation: Introduced a comprehensive suite of new documentation for Celestia operators, covering consensus validators, data availability nodes, and various operational aspects.
  • Consensus Validator Guides: Added detailed guides for installing celestia-app, CLI command references, metrics and monitoring setup, slashing and jailing mechanics, and upgrade monitoring for consensus validators.
  • Data Availability Node Guides: Provided new documentation for installing celestia-node, setting up light and bridge nodes, configuration references, custom network setups, metrics for DA nodes, and ZFS storage optimization.
  • Key Management and Wallets: Included new guides for creating and managing wallets with celestia-app and the cel-key utility, along with documentation for multisig and vesting accounts.
  • Network and Maintenance Information: Expanded information on Celestia networks (Mainnet Beta, Mocha, Arabica, local devnet), network upgrade processes, node snapshots, SystemD service setup, and a comprehensive troubleshooting guide.
  • Documentation Structure and Navigation: Improved navigation and organization by adding _meta.js files across various sections and renaming the main operate page for consistency.
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 is a significant migration of documentation content into a new structure under the operate section. It adds numerous new guides, CLI references, and other documentation for operators. While the content itself is a great improvement, the migration has resulted in a large number of broken internal links across the new documentation files. My review focuses on identifying these broken links, as they critically impact user navigation and the overall quality of the documentation. I have also pointed out some issues with command examples and content clarity that could be improved.

Comment thread app/operate/data-availability/light-node/page.mdx Outdated
Comment thread app/operate/maintenance/network-upgrades/page.mdx Outdated
Comment thread app/operate/networks/overview/page.mdx Outdated
Comment thread app/operate/consensus-validators/consensus-node/page.mdx Outdated
Comment thread app/operate/consensus-validators/install-celestia-app/page.mdx Outdated
Comment thread app/operate/consensus-validators/cli-reference/page.mdx Outdated
Comment thread app/operate/consensus-validators/cli-reference/page.mdx
Comment thread app/operate/consensus-validators/validator-node/page.mdx
Comment thread app/operate/consensus-validators/validator-node/page.mdx Outdated
Comment thread app/operate/consensus-validators/cli-reference/page.mdx Outdated
@jcstein jcstein merged commit f4fc20b into docs-glow-up Dec 5, 2025
3 checks passed
@jcstein jcstein deleted the gb/new-operate branch December 5, 2025 23:17
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