Skip to content

docs: client lib#2122

Merged
jcstein merged 3 commits intomainfrom
jcs/client-lib
Jun 30, 2025
Merged

docs: client lib#2122
jcstein merged 3 commits intomainfrom
jcs/client-lib

Conversation

@jcstein
Copy link
Copy Markdown
Member

@jcstein jcstein commented Jun 26, 2025

Overview

Resolves #2109

  1. overview page
  2. Go client page

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.

Summary of Changes

Hello @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 significantly expands the documentation by introducing new guides for Celestia client libraries. The primary focus is on the Golang client, providing developers with practical examples and setup instructions for interacting with Celestia nodes to read and submit data. It also includes a general overview of client functionalities and architectural considerations.

Highlights

  • New Documentation Section: Introduced a new top-level section in the sidebar navigation for 'Celestia clients' under 'How-to Guides', which is collapsed by default.
  • Golang Client Guide: Added a comprehensive guide for the Celestia Golang client, covering installation, configuration, and a detailed working example for initializing a keyring, checking balance, submitting, and retrieving blobs.
  • Client Overview: Included an overview page for Celestia clients, explaining their purpose, features, available implementations (Go and Rust), and the distinction between read (Bridge node) and submit (Consensus node) endpoints, along with security tips.
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 in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

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 issue 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 is currently in preview and 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 to provide feedback.

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.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Jun 26, 2025

PR Preview Action v1.6.1

🚀 View preview at
https://celestiaorg.github.io/docs-preview/pr-2122/

Built to branch main at 2025-06-30 17:49 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
@jcstein jcstein requested a review from Copilot June 26, 2025 23:26
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

Adds documentation and navigation support for the new Celestia client libraries.

  • Introduces a high-level overview of the Celestia client
  • Provides a detailed Go client guide with usage examples
  • Updates the VitePress sidebar to include the new client pages

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.

File Description
how-to-guides/client/overview.md New overview page for Celestia clients
how-to-guides/client/go.md Detailed guide and example for the Go client
.vitepress/config.ts Sidebar updated to surface the client documentation
Comments suppressed due to low confidence (2)

how-to-guides/client/overview.md:27

  • [nitpick] Consider adding a link (or placeholder link) to the Rust client guide for consistency with the Go client entry, even if the guide is not yet published.
- Rust client: This client is a work in progress. It is being designed to offer a similar developer experience for Rust users.

how-to-guides/client/go.md:51

  • [nitpick] The phrase "from above" could be confusing since the full example is presented immediately below. Consider rephrasing to "Use the example below" for clarity.
Save the full example from above into `main.go`. Here’s a working version with import formatting and placeholder values cleaned up:

@jcstein jcstein requested review from cmwaters and walldiss June 26, 2025 23:28
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 adds documentation for the Celestia Go client library, including an overview and a guide with an example project. It also updates the sidebar configuration to include links to the new client documentation. The documentation provides instructions on how to install the client, create a project, and perform basic operations like submitting and retrieving blobs.

Comment thread .vitepress/config.ts
Comment thread how-to-guides/client/go.md
Comment thread how-to-guides/client/go.md
Comment thread how-to-guides/client/go.md
Comment thread how-to-guides/client/go.md
Comment thread how-to-guides/client/overview.md
Copy link
Copy Markdown
Contributor

@cmwaters cmwaters left a comment

Choose a reason for hiding this comment

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

Looks good as a first version!

Comment thread how-to-guides/client/go.md Outdated
go run main.go
```

If this is the first time running the program, you’ll see a mnemonic and address output which is your key. After you’ve funded it at the [Mocha faucet](/how-to-guides/mocha-testnet.md#mocha-testnet-faucet), run it again to post your blob.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Is there a faucet that can be used programatically?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

not currently. we could ask Celenium to provide this?

@jcstein jcstein merged commit 072caaa into main Jun 30, 2025
7 checks passed
@jcstein jcstein deleted the jcs/client-lib branch June 30, 2025 17:48
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.

feat: document client library

3 participants