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: add trusted hash doc resolve #1460 #1651

Merged
merged 3 commits into from
Jul 31, 2024
Merged

docs: add trusted hash doc resolve #1460 #1651

merged 3 commits into from
Jul 31, 2024

Conversation

jcstein
Copy link
Member

@jcstein jcstein commented Jul 25, 2024

Overview

Resolves #1460

Direct link to preview

Screenshot 2024-07-25 at 12 55 06 PM

Summary by CodeRabbit

  • New Features
    • Added a new sidebar entry titled "Syncing a light node from a trusted hash" for easier navigation.
    • Introduced a comprehensive guide on syncing light nodes from a trusted hash, detailing setup for Mainnet Beta and other networks.
  • Documentation
    • Enhanced user resources with a step-by-step guide on initializing and running a light node, focusing on trust and configuration details.

@jcstein jcstein requested review from S1nus and rootulp July 25, 2024 16:56
@jcstein jcstein self-assigned this Jul 25, 2024
Copy link
Contributor

coderabbitai bot commented Jul 25, 2024

Warning

Rate limit exceeded

@jcstein has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 19 minutes and 12 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between b08bf31 and d7535f6.

Walkthrough

The recent changes enhance the Celestia documentation by introducing a new guide on syncing a light node from a trusted hash. This addition not only improves sidebar navigation but also provides detailed instructions for users on setting up their nodes securely, addressing various network configurations. Overall, these updates contribute to a more informative and user-friendly experience.

Changes

File Change Summary
.vitepress/config.ts, nodes/celestia-node-trusted-hash.md Added a sidebar entry titled "Syncing a light node from a trusted hash" and created a new guide detailing the sync process, configuration steps, and trust considerations.

Assessment against linked issues

Objective Addressed Explanation
Add documentation for syncing from trusted hash and height (#1460)
Provide clear setup instructions for various networks (#1460)
Clarify trust assumptions when syncing from a trusted hash (#1460)

Poem

🐰 In the land of Celestia bright,
A guide was born to share the light.
Sync your nodes with trusted grace,
Hash and height, you'll find your place.
With every step, a bunny cheer,
For knowledge shared brings us near! 🌟


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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

Copy link
Contributor

github-actions bot commented Jul 25, 2024

PR Preview Action v1.4.7
🚀 Deployed preview to https://celestiaorg.github.io/docs-preview/./pr-1651/
on branch main at 2024-07-25 17:07 UTC

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 1470a35 and b08bf31.

Files selected for processing (2)
  • .vitepress/config.ts (1 hunks)
  • nodes/celestia-node-trusted-hash.md (1 hunks)
Files skipped from review due to trivial changes (1)
  • .vitepress/config.ts
Additional context used
LanguageTool
nodes/celestia-node-trusted-hash.md

[uncategorized] ~13-~13: You might be missing the article “the” here.
Context: ...ssumption that you trust the history of chain up to that point and that you trust the...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)


[uncategorized] ~37-~37: Possible missing article found.
Context: ... them all rollups or applications using same starting height.

(AI_HYDRA_LEO_MISSING_THE)

Additional comments not posted (3)
nodes/celestia-node-trusted-hash.md (3)

1-5: LGTM!

The description and title are clear and concise.


7-10: LGTM!

The introductory paragraph is clear and provides necessary context.


18-32: LGTM!

The step-by-step instructions are clear and well-structured.

nodes/celestia-node-trusted-hash.md Outdated Show resolved Hide resolved
nodes/celestia-node-trusted-hash.md Outdated Show resolved Hide resolved
@jcstein jcstein requested review from distractedm1nd and removed request for rootulp July 25, 2024 17:01
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
@jcstein jcstein changed the title feat: add trusted hash doc resolve #1460 docs: add trusted hash doc resolve #1460 Jul 25, 2024
@Bidon15
Copy link
Member

Bidon15 commented Jul 31, 2024

Nice!

@Bidon15 Bidon15 merged commit 92c20bb into main Jul 31, 2024
4 checks passed
@Bidon15 Bidon15 deleted the jcs/trust-hash branch July 31, 2024 08:02
@coderabbitai coderabbitai bot mentioned this pull request Nov 28, 2024
4 tasks
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.

feat: add docs for syncing from trusted hash and height
2 participants