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: update rpcs based on dead links from https://celestia-tools.bri… #1745

Merged
merged 1 commit into from
Sep 30, 2024

Conversation

jcstein
Copy link
Member

@jcstein jcstein commented Sep 30, 2024

Overview

Resolves #1744

Summary by CodeRabbit

  • Documentation
    • Updated the Mainnet Beta document for clarity, emphasizing its significance and detailing network stability.
    • Expanded the network parameters section with a breakdown of transaction sizes.
    • Added a comprehensive list of RPC endpoints and instructions for connecting various node types.
    • Enhanced the Mocha testnet guide with detailed instructions and resources for developers and validators.

Copy link
Contributor

coderabbitai bot commented Sep 30, 2024

Caution

Review failed

The pull request is closed.

Walkthrough

The pull request introduces significant updates to the documentation for Celestia's Mainnet Beta and Mocha testnet. It enhances clarity by refining sections on network stability, transaction parameters, and node integrations. The updates include detailed explanations of RPC endpoints and instructions for connecting various node types, alongside expanded resources for tracking network activity. The changes aim to improve usability for developers and validators while ensuring accurate information about the experimental nature of the networks.

Changes

Files Change Summary
nodes/mainnet.md Refined introduction, expanded sections on network stability, transaction parameters, integrations, and explorers. Added warnings about community endpoints.
nodes/mocha-testnet.md Comprehensive guide on connecting to Mocha testnet, detailing node types, network details, and faucet process.

Assessment against linked issues

Objective Addressed Explanation
Remove unreachable endpoints from docs (#1744) No specific removal of unreachable endpoints noted in the changes.

Possibly related PRs

Suggested labels

documentation, enhancement

Poem

🐰 In the land of Celestia, bright and wide,
The Mainnet Beta takes us on a ride.
With nodes and endpoints, oh what a sight,
Developers gather, ready to write!
Mocha testnet's calling, come join the fun,
Together we build, until the day is done! 🌟


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@jcstein jcstein merged commit dee25d6 into main Sep 30, 2024
3 of 4 checks passed
@jcstein jcstein deleted the jcs/remove-dead-rpcs branch September 30, 2024 20:06
Copy link
Contributor

PR Preview Action v1.4.8
🚀 Deployed preview to https://celestiaorg.github.io/docs-preview/./pr-1745/
on branch main at 2024-09-30 20:06 UTC

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.

docs: remove unreachable endpoints from docs
1 participant