Skip to content

docs: update retrievability and remove ai garble#1920

Merged
jcstein merged 1 commit intomainfrom
jcs/archival-providers
Mar 5, 2025
Merged

docs: update retrievability and remove ai garble#1920
jcstein merged 1 commit intomainfrom
jcs/archival-providers

Conversation

@jcstein
Copy link
Copy Markdown
Member

@jcstein jcstein commented Mar 5, 2025

Overview

Summary by CodeRabbit

  • Documentation
    • Removed an outdated guide on comprehensive node setup.
    • Added a resource link to enhance archival data access information.
    • Expanded guidance for retrieving historical data, emphasizing the benefits of professional archival node providers.
    • Streamlined network endpoint information to simplify resource navigation.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Mar 5, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

This pull request updates several documentation files for Celestia. Two files providing comprehensive guides on node setup and network endpoints were removed. Meanwhile, the mainnet guide now includes a QuickNode link under archival DA nodes, and the retrievability guide was expanded to clarify details on archival node providers and historical data retrieval. No modifications were made to any public entities.

Changes

File(s) Change Summary
how-to-guides/common-node-setup.md
reference/network-endpoints.md
Deleted files: Removed comprehensive guides on node setup procedures and network endpoint details.
how-to-guides/mainnet.md
learn/retrievability.md
Updated documentation: Added a QuickNode link in the mainnet guide and expanded archival node/provider details in the retrievability guide.

Possibly related PRs

Poem

I'm a rabbit with a clever hop,
Skipping through docs that now don't stop.
Guides have vanished and links now bloom,
QuickNode joins the Celestia room.
With every line, a playful cheer—
Hopping happily into the code frontier!
🐇✨


📜 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 b5b767f and 23b1815.

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

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
  • @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 b021f2f into main Mar 5, 2025
3 checks passed
@jcstein jcstein deleted the jcs/archival-providers branch March 5, 2025 21:38
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Mar 5, 2025

PR Preview Action v1.6.0

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

Built to branch main at 2025-03-05 21:39 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