docs: updates for pda, menu, and rust client #2322
Conversation
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 focuses on enhancing and expanding the project's documentation. It includes updates to client library documentation, specifically for Go and introducing a new Rust client, and a comprehensive rewrite of the "Private Data Availability" feature explanation, now termed "Private Blockspace," to provide clearer insights into its functionality and applications. 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
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request provides several documentation updates, including a significant rewrite of the 'Private Blockspace' page, the addition of a new page for the Rust client, and other minor adjustments. The changes greatly improve the clarity and structure of the documentation. I have one suggestion for the new Rust client page to enhance formatting and clarify that it's a community-developed client, which will help manage user expectations.
| ## (`celestia-client`) | ||
|
|
||
| Lumina’s Rust client library provides a high-level API for interacting with a Celestia node over RPC and gRPC. It builds on top of the lower-level `celestia-rpc` and `celestia-grpc` crates and exposes a unified `Client` that supports both **read-only** and **submit** modes. In read-only mode, the client connects to a node via RPC (and optionally gRPC) to query headers, blobs, and state. In submit mode, it additionally uses gRPC and a local signer to build, sign, and broadcast transactions such as transfers and PayForBlobs. The crate re-exports common Celestia types (namespaces, blobs, app versions, etc.) and is designed to be the easiest way for Rust applications to integrate with Celestia nodes for data retrieval, blob submission, and general chain interaction. ([lib.rs][1]) |
There was a problem hiding this comment.
A couple of suggestions to improve clarity and formatting on this new page:
- The parentheses in the subtitle
(\celestia-client`)` are unconventional for a Markdown heading. It's clearer to just use backticks for the crate name. - Referring to the client as "Lumina’s Rust client library" might be confusing, as it could imply it's an official client. Since it's a community-developed client, it's better to refer to it by its crate name,
celestia-client, to align with the title and manage user expectations about support.
## `celestia-client`
The `celestia-client` Rust library provides a high-level API for interacting with a Celestia node over RPC and gRPC. It builds on top of the lower-level `celestia-rpc` and `celestia-grpc` crates and exposes a unified `Client` that supports both **read-only** and **submit** modes. In read-only mode, the client connects to a node via RPC (and optionally gRPC) to query headers, blobs, and state. In submit mode, it additionally uses gRPC and a local signer to build, sign, and broadcast transactions such as transfers and PayForBlobs. The crate re-exports common Celestia types (namespaces, blobs, app versions, etc.) and is designed to be the easiest way for Rust applications to integrate with Celestia nodes for data retrieval, blob submission, and general chain interaction. ([lib.rs][1])
Overview