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.

Sign up for GitHub

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

Jump to bottom

docs: update celestia-da for changes on GM #438

Merged
merged 2 commits into from
Aug 27, 2024
Merged

docs: update celestia-da for changes on GM #438

merged 2 commits into from
Aug 27, 2024

Conversation

jcstein
Copy link
Member

@jcstein jcstein commented Aug 27, 2024 •
edited by coderabbitai bot
Loading

  1. Now that GM tutorial uses Kurtosis, Ignite is not installed once someone goes through GM tutorial. This PR updates the prerequisites so that the user installs the correct version of ignite. I hit issues ignite v28.5.0 panic #421 (comment) when installing newer version from ignite's site on this tutorial.
  2. Adds the --rollkit.da_address flag and explains what it is so that user can communicate with default light node setup easily.

Overview

Summary by CodeRabbit

  • Documentation
    • Updated the guide for setting up a light node in the Celestia ecosystem for improved clarity and flow.
    • Enhanced prerequisites section with clearer installation requirements for rollkit and ignite CLIs, specifying the required version of ignite CLI (v28.4.0).
    • Added instructions for configuring the DA address for the light node, including the default port and necessary commands.

@jcstein
docs: update celestia-da for changes on GM
51ff372 
1. Now that GM tutorial uses Kurtosis, Ignite is not installed once someone goes through GM tutorial. This PR updates the prerequisites so that the user installs the correct version of ignite. I hit issues #421 (comment) when installing newer version from ignite's site on this tutorial. 
2. Adds the `--rollkit.da_address` flag and explains what it is so that user can communicate with default light node setup easily.
@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Aug 27, 2024 •
edited
Loading

Walkthrough

The documentation for setting up a light node in the Celestia ecosystem has been updated. Key changes include a clearer prerequisites section detailing installation requirements for the rollkit and ignite CLIs, with a specific version of the ignite CLI highlighted. Additionally, new instructions for configuring the DA address have been added, improving the overall clarity and flow of the setup process.

Changes

Files Change Summary
tutorials/celestia-da.md Restructured prerequisites section for clarity, emphasized required ignite CLI version, updated setup instructions, and added guidance for configuring DA address.

Poem

In the land of Celestia bright,
A light node now takes flight.
With clearer paths and ports in sight,
Set your DA with pure delight!
Hop along, the setup’s grand,
Join the network, take a stand! 🐇✨

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.

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Aug 27, 2024 •
edited
Loading

PR Preview Action v1.4.7
🚀 Deployed preview to https://rollkit.github.io/docs-preview/./pr-438/
on branch main at 2024-08-27 18:40 UTC

coderabbitai[bot]
coderabbitai bot reviewed Aug 27, 2024
View reviewed changes
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: 0

Outside diff range, codebase verification and nitpick comments (1)
tutorials/celestia-da.md (1)

28-29: Fix markdown linting issue.

Change the unordered list style from asterisk to dash for consistency.

-* `rollkit` CLI installed from the [GM world rollup](/tutorials/gm-world) tutorial.
-* `ignite` CLI v28.4.0 installed `curl https://get.ignite.com/[email protected]! | bash`
+- `rollkit` CLI installed from the [GM world rollup](/tutorials/gm-world) tutorial.
+- `ignite` CLI v28.4.0 installed `curl https://get.ignite.com/[email protected]! | bash`
Tools
Markdownlint

28-28: Expected: dash; Actual: asterisk
Unordered list style

(MD004, ul-style)

29-29: Expected: dash; Actual: asterisk
Unordered list style

(MD004, ul-style)

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between b384f1d and a18f847.

Files selected for processing (1)
  • tutorials/celestia-da.md (4 hunks)
Additional context used
Markdownlint
tutorials/celestia-da.md

28-28: Expected: dash; Actual: asterisk
Unordered list style

(MD004, ul-style)

29-29: Expected: dash; Actual: asterisk
Unordered list style

(MD004, ul-style)

Additional comments not posted (2)
tutorials/celestia-da.md (2)

148-153: LGTM!

The addition of the DA address configuration is clear and helpful.

165-165: LGTM!

The addition of the --rollkit.da_address flag is correct and aligns with the new DA address configuration section.

@Manav-Aggarwal Manav-Aggarwal merged commit 056722c into main Aug 27, 2024
4 checks passed
@Manav-Aggarwal Manav-Aggarwal deleted the jcstein-patch-1 branch August 27, 2024 18:59
@a26nine
Copy link
Contributor

a26nine commented Aug 27, 2024

Related: ignite/cli#4318

@coderabbitai coderabbitai bot mentioned this pull request Sep 9, 2024
Merged
@coderabbitai coderabbitai bot mentioned this pull request Oct 7, 2024
Merged
@coderabbitai coderabbitai bot mentioned this pull request Nov 19, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@Manav-Aggarwal Manav-Aggarwal Manav-Aggarwal approved these changes

@gupadhyaya gupadhyaya Awaiting requested review from gupadhyaya

@MSevey MSevey Awaiting requested review from MSevey

Assignees

@jcstein jcstein

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@jcstein @a26nine @Manav-Aggarwal