Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: make rpc and api sections more digestible #1746

Open
jcstein opened this issue Sep 30, 2024 · 1 comment
Open

docs: make rpc and api sections more digestible #1746

jcstein opened this issue Sep 30, 2024 · 1 comment

Comments

@jcstein
Copy link
Member

jcstein commented Sep 30, 2024

discussion in slack

@jcstein
Copy link
Member Author

jcstein commented Sep 30, 2024

AI suggestion:

I understand the confusion. Here's a structured plan to make the RPC/API sections more readable and clear:

1. Separate Consensus and DA Endpoints Clearly

Current Issue:

  • Consensus node endpoints are required for DA nodes to post data, but they are listed under DA sections, causing confusion.

Solution:

  • Create distinct sections for Consensus Endpoints and DA Endpoints.
  • Add clarifications that some Consensus Endpoints can be used with DA nodes.

2. Clarify Usage of Endpoints

Current Issue:

  • Lack of clarity on which endpoints can be used with light nodes or bridge nodes.

Solution:

  • Add a brief explanation under each section about the usage of the endpoints.

Example:

Consensus Endpoints

  • Usage: These endpoints are primarily for consensus operations but can also be used by DA nodes (light, bridge) to post data.

3. Reduce Bulleted Lists and White Space

Current Issue:

  • Bulleted lists eat up a lot of space and cause white space.

Solution:

  • Use a table format to list endpoints, which is more compact and readable.

Example Table:

Endpoint Type Endpoint Port
Consensus RPC public-celestia-rpc.numia.xyz 26657
Consensus gRPC public-celestia-rpc.numia.xyz 9090
DA RPC public-celestia-lcd.numia.xyz 1317
DA gRPC public-celestia-lcd.numia.xyz 9090

5. Provide a Summary

Current Issue:

  • Users might miss the overall purpose of each endpoint type.

Solution:

  • Provide a brief summary at the beginning of each section.

Example Summary:

Consensus Endpoints:

  • Used for consensus operations and can be utilized by DA nodes for posting data.

DA Endpoints:

  • Used for querying data on Celestia, sampling data, and broadcasting transactions without running a full consensus node.

Implementation Example:

## Consensus Endpoints
**Purpose:** Used for consensus operations and can also be used by DA nodes to post data.

| Endpoint Type | Endpoint | Port |
| ------------- | -------- | ---- |
| Consensus RPC | `public-celestia-rpc.numia.xyz` | 26657 |
| Consensus gRPC | `public-celestia-rpc.numia.xyz` | 9090 |
| Consensus RPC | `celestia-rpc.mesa.newmetric.xyz` | 26657 |
| Consensus gRPC | `celestia-rpc.mesa.newmetric.xyz` | 9090 |

## Data Availability (DA) Endpoints
**Purpose:** Used for querying the chain’s state and broadcasting transactions without running a full node.

| Endpoint Type | Endpoint | Port |
| ------------- | -------- | ---- |
| DA RPC | `public-celestia-lcd.numia.xyz` | 1317 |
| DA gRPC | `public-celestia-lcd.numia.xyz` | 9090 |
| DA RPC | `celestia-rest.mesa.newmetric.xyz` | 1317 |
| DA gRPC | `celestia-rest.mesa.newmetric.xyz` | 9090 |

## Trusted Endpoints
**Provider:** DevOps, P-OPS

| Endpoint Type | Endpoint | Port |
| ------------- | -------- | ---- |
| Trusted RPC | `trusted-celestia-rpc.devops.xyz` | 26657 |
| Trusted gRPC | `trusted-celestia-rpc.devops.xyz` | 9090 |
| Trusted RPC | `trusted-celestia-rpc.pops.xyz` | 26657 |
| Trusted gRPC | `trusted-celestia-rpc.pops.xyz` | 9090 |

## Community Endpoints
**Provider:** Various community members

| Endpoint Type | Endpoint | Port |
| ------------- | -------- | ---- |
| Community RPC | `public-celestia-rpc.numia.xyz` | 26657 |
| Community gRPC | `public-celestia-rpc.numia.xyz` | 9090 |
| Community RPC | `celestia-rpc.mesa.newmetric.xyz` | 26657 |
| Community gRPC | `celestia-rpc.mesa.newmetric.xyz` | 9090 |

Relevant Links:

This should make the documentation more readable and user-friendly.

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

No branches or pull requests

1 participant