docs: link docker setup to consensus endpoints with RPC and gRPC#2440
docs: link docker setup to consensus endpoints with RPC and gRPC#2440
Conversation
Summary of ChangesHello, 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 enhances the clarity and accuracy of network endpoint documentation, particularly for Docker setup and testnet configurations. By standardizing terminology to 'consensus endpoint' and explicitly detailing the requirement for both RPC and gRPC services, the changes aim to provide users with more precise and comprehensive guidance for connecting to various networks. Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Changelog
Activity
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 updates the documentation to clarify the use of consensus endpoints that provide both RPC and gRPC services, particularly for Docker setups. The changes are generally good and improve clarity. I've added two comments: one suggests renaming some environment variables in the Docker setup guide for better readability and consistency, and the other points out a potential inconsistency created by removing an endpoint from a list in the Mocha testnet documentation while it's still being used in examples elsewhere.
I am having trouble creating individual review comments. Click here to see my feedback.
app/operate/getting-started/docker/page.mdx (92-98)
The variable names RPC_URL and RPC_PORT are misleading now that they refer to a consensus host and a gRPC port. To improve clarity for users, consider renaming them.
For example, you could use CONSENSUS_HOST and GRPC_PORT:
export CONSENSUS_HOST=this-is-an-rpc-url.comThen set the gRPC port for the CONSENSUS_HOST host:
export GRPC_PORT=9090If you make this change, please also update the docker run commands further down in the file to use these new variable names (e.g., ... --core.ip $CONSENSUS_HOST --core.port $GRPC_PORT ...).
app/operate/networks/mocha-testnet/page.mdx (112-118)
The endpoint rpc-mocha.pops.one has been removed from this list. However, it is still used as an example endpoint in other documentation pages, such as app/operate/data-availability/light-node/quickstart/page.mdx and app/operate/data-availability/bridge-node/page.mdx.
If rpc-mocha.pops.one is no longer a recommended consensus endpoint, the examples in other files should be updated to use one of the endpoints from the new 'Community consensus endpoints' table. If it is still valid and provides both RPC and gRPC from the same host, it should be added to that table for consistency.
|
🚀 Preview Deployment Your preview is ready: https://celestiaorg.github.io/docs-preview/pr-2440/ |
There was a problem hiding this comment.
Pull request overview
Updates the Docker setup documentation so Mocha and Arabica network links land on sections that explicitly list consensus endpoints where both RPC (26657) and gRPC (9090) are available from the same host (addressing #1625).
Changes:
- Updated Docker quickstart wording and network links to point to “Community consensus endpoints” anchors for Mocha and Arabica.
- Added a “Community consensus endpoints” table to the Mocha network page with
--core.iphosts and RPC/gRPC ports. - Renamed the Arabica “Community RPC endpoints” section heading to “Community consensus endpoints” to match the new Docker link target.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| app/operate/getting-started/docker/page.mdx | Updates wording/links to direct users to consensus endpoints that support both RPC and gRPC; clarifies port intent. |
| app/operate/networks/mocha-testnet/page.mdx | Introduces a dedicated consensus-endpoints table (with both ports) and points bridge-node guidance to it. |
| app/operate/networks/arabica-devnet/page.mdx | Renames the community section heading (and a sentence) so Docker links resolve directly to the intended endpoint list. |
Comments suppressed due to low confidence (1)
app/operate/getting-started/docker/page.mdx:99
- This step says to set the gRPC port, but the environment variable is named
RPC_PORT. To keep terminology consistent (and reduce chances of setting 26657 by mistake), consider renaming it to something likeGRPC_PORT/CORE_PORT, or explicitly note here that--core.portshould be the consensus gRPC port (usually 9090).
Then set the gRPC port for the `RPC_URL` host:
```bash
export RPC_PORT=9090
</details>
---
💡 <a href="/celestiaorg/docs/new/main?filename=.github/instructions/*.instructions.md" class="Link--inTextBlock" target="_blank" rel="noopener noreferrer">Add Copilot custom instructions</a> for smarter, more guided reviews. <a href="https://docs.github.com/en/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot" class="Link--inTextBlock" target="_blank" rel="noopener noreferrer">Learn how to get started</a>.
| using the bare URL (without http or https): | ||
|
|
||
| ```bash | ||
| export RPC_URL=this-is-an-rpc-url.com |
There was a problem hiding this comment.
The doc now describes configuring a “consensus endpoint”, but the instructions and variable name still call it RPC_URL and describe it as a “bare URL (without http or https)”. Since the value is actually a hostname used for --core.ip, consider renaming the env var (e.g., CORE_IP/CONSENSUS_HOST) or adjusting the wording to consistently call this a host/endpoint (not a URL) to avoid confusion.
| using the bare URL (without http or https): | |
| ```bash | |
| export RPC_URL=this-is-an-rpc-url.com | |
| using the consensus endpoint host (without `http://` or `https://`): | |
| ```bash | |
| export RPC_URL=consensus.example.com |
| > **Warning:** Do not rely on the free community endpoints listed below for production deployments. Production deployments should rely on [service providers with SLAs](#production-rpc-endpoints) or your own node. | ||
|
|
||
| RPC endpoints and types of nodes you can run in order to participate in Arabica devnet: | ||
| Consensus endpoints and node types you can run in order to participate in Arabica devnet: |
There was a problem hiding this comment.
The section heading was renamed to “Community consensus endpoints”, but the intro sentence now says “Consensus endpoints…” while the table includes multiple endpoint types (Consensus RPC, API, gRPC, and direct hostnames). Consider rephrasing this line to clarify that these are consensus-node endpoints and that the table lists RPC/API/gRPC options, so readers don’t interpret it as “consensus-only” endpoints.
| Consensus endpoints and node types you can run in order to participate in Arabica devnet: | |
| Consensus-node endpoints and node types you can run in order to participate in Arabica devnet, including RPC, API, gRPC, and direct hostnames: |
Overview
Fixes #1625.
This PR updates the Docker setup docs so the network links point to sections that clearly list consensus endpoints with both RPC and gRPC.
app/operate/getting-started/docker/page.mdx.--core.iphosts plus RPC (26657) and gRPC (9090) ports inapp/operate/networks/mocha-testnet/page.mdx.app/operate/networks/arabica-devnet/page.mdx.Validation
/operate/networks/mocha-testnet#community-consensus-endpoints/operate/networks/arabica-devnet#community-consensus-endpointsnpm run lint -- app/operate/getting-started/docker/page.mdx app/operate/networks/mocha-testnet/page.mdx app/operate/networks/arabica-devnet/page.mdxcould not run in this environment becauseeslintis not installed.