Eliminate extra section on operate #2339
Conversation
- 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.
Summary of ChangesHello @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
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 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.
jcstein
left a comment
There was a problem hiding this comment.
1 small change to audits table, otherwise LGTM
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:
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]optional-services/_meta.jsto more appropriate locations in the metadata structure, and the obsolete testnet instantiation guide has been removed. [1] [2] [3] [4]Node API and navigation updates:
Internal tooling fixes:
check-links.mjsscript, including handling of case-insensitive redirects and simplifying function signatures. [1] [2] [3] [4]