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

fix: typos in documentation files #1837

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Conversation

vtjl10
Copy link

@vtjl10 vtjl10 commented Dec 20, 2024

Corrected celestia <da_type> start –core.ip <url> -–core.grpc.port <port> to celestia <da_type> start --core.ip <url> --core.grpc.port <port>
Corrected dont to don't

Summary by CodeRabbit

  • New Features

    • Enhanced the Arabica devnet guide with updated information and clearer instructions.
    • Added a troubleshooting section to the quick-start guide for setting up a Celestia light node.
  • Bug Fixes

    • Improved clarity in instructions for initializing light nodes and setting trusted hashes.
  • Documentation

    • Updated sections on network stability, RPC endpoints, and faucet usage in the Arabica devnet guide.
    • Refined language and structure in the quick-start guide for better user engagement.

Copy link
Contributor

coderabbitai bot commented Dec 20, 2024

Walkthrough

The pull request focuses on updating two documentation files: arabica-devnet.md and quick-start.md. The changes aim to improve clarity, provide more detailed guidance, and enhance the user experience for developers interacting with the Celestia network. The updates include refined introductions, more structured information about network endpoints, clearer instructions for node initialization, and additional troubleshooting guidance.

Changes

File Change Summary
how-to-guides/arabica-devnet.md - Refined introduction emphasizing Arabica as a developer-focused testnet
- Added warning about network stability and potential breaks
- Expanded "Integrations" section with detailed RPC endpoint information
- Updated faucet instructions with Discord token request guidance
- Added explorers section and network upgrade communication channel
how-to-guides/quick-start.md - Updated description and introduction
- Clarified light node initialization instructions
- Emphasized mnemonic preservation
- Refined trusted hash sync instructions
- Added troubleshooting section

Possibly related PRs

Suggested Reviewers

  • jcstein
  • rootulp

Poem

🐰 A Rabbit's Ode to Documentation Delight

In Celestia's realm of bits and bytes,
Guides now shine with clearer lights,
From Arabica's devnet to quick starts so neat,
Our knowledge path is now complete!

🚀 Hop, hop, hurray! 🌟


📜 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 113e861 and b3ffdbc.

📒 Files selected for processing (2)
  • how-to-guides/arabica-devnet.md (1 hunks)
  • how-to-guides/quick-start.md (1 hunks)
🔇 Additional comments (2)
how-to-guides/arabica-devnet.md (1)

121-121: Command syntax correctly updated

The command syntax now correctly uses double dashes (--) for flags, which matches the standard CLI flag format.

how-to-guides/quick-start.md (1)

87-87: ⚠️ Potential issue

Fix typo in warning message

The contraction "don't" is missing an apostrophe.

Apply this diff to fix the typo:

-> If you don't do this, when trying to retrieve data in a few minutes, you'll see a response saying `"result": "header: syncing in progress: localHeadHeight: 94721, requestedHeight: 2983850"`. You'll either need to let the node sync to the `requestedHeight`, or use quick sync with trusted hash to do this.
+> If you don't do this, when trying to retrieve data in a few minutes, you'll see a response saying `"result": "header: syncing in progress: localHeadHeight: 94721, requestedHeight: 2983850"`. You'll either need to let the node sync to the `requestedHeight`, or use quick sync with trusted hash to do this.

Likely invalid or redundant comment.


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.

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