Skip to content

docs: remove dead core endpoints#1897

Merged
jcstein merged 1 commit intomainfrom
jcs/rm-dead-core-endpoints
Feb 20, 2025
Merged

docs: remove dead core endpoints#1897
jcstein merged 1 commit intomainfrom
jcs/rm-dead-core-endpoints

Conversation

@jcstein
Copy link
Copy Markdown
Member

@jcstein jcstein commented Feb 20, 2025

Overview

Summary by CodeRabbit

  • New Features

    • Introduced a comprehensive guide with step-by-step instructions for node setup, covering environment preparation, key management, and node migration.
    • Added a detailed reference guide on network endpoints, explaining production, community, and data availability node endpoints alongside recommended usage practices.
  • Documentation

    • Updated main network documentation by removing outdated community service endpoints.
    • Refined testnet guidance by eliminating references to specific third-party endpoints.

@jcstein jcstein merged commit 8b2db4c into main Feb 20, 2025
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Feb 20, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

This pull request introduces two new documentation files and updates existing guides. A new "Common Node Setup Guide" provides step-by-step instructions for setting up various Celestia node types, covering environment configurations, key management, node migration, and network settings. Additionally, a new "Network Endpoints" document offers a comprehensive reference to production, community, and DA node endpoints. The mainnet and Mocha testnet guides have been updated by removing deprecated community endpoints, with warnings retained regarding their use in production environments.

Changes

File(s) Change Summary
how-to-guides/common-node-setup.md New document detailing common node setup, including environment setup, key management, node migration, optional service configuration, and network port settings.
how-to-guides/mainnet.md, how-to-guides/mocha-testnet.md Removed deprecated community endpoints (RPC, API, gRPC, and explorer) and retained warnings about their unreliability for production deployments.
reference/network-endpoints.md New document providing a comprehensive reference of production, community, and DA node endpoints with usage instructions and configuration tips.

Suggested labels

documentation

Poem

I'm Bunny, hopping through these docs with glee,
Bringing setup guides and endpoints for all to see.
Keys and nodes now fall in line,
As deprecated endpoints take their leave in time.
With whiskers twitching and ears held high,
I celebrate these changes—oh my, oh my!
🐰✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f1b8f70 and 58c472b.

📒 Files selected for processing (4)
  • how-to-guides/common-node-setup.md (1 hunks)
  • how-to-guides/mainnet.md (0 hunks)
  • how-to-guides/mocha-testnet.md (0 hunks)
  • reference/network-endpoints.md (1 hunks)

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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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 deleted the jcs/rm-dead-core-endpoints branch February 20, 2025 11:13
@github-actions
Copy link
Copy Markdown
Contributor

PR Preview Action v1.6.0

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

Built to branch main at 2025-02-20 11:14 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

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.

1 participant