feat: update tutorial to use quick start instead of GM #481
Conversation
WalkthroughThe pull request updates the Changes
Possibly related PRs
Suggested reviewers
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Outside diff range and nitpick comments (2)
tutorials/celestia-da.md (2)
Line range hint
16-22: LGTM: Streamlined light node instructionsThe updated section effectively simplifies the instructions for running a Celestia light node across different networks. This change aligns well with the goal of streamlining the tutorial.
Consider adding a brief note or link for users who might need guidance on funding their wallet, especially for Mainnet Beta. This could help prevent potential confusion without cluttering the main instructions.
28-28: LGTM: Simplified prerequisitesThe updated prerequisites section effectively streamlines the tutorial by referencing the quick start guide. This change aligns well with the PR objectives and makes the tutorial more accessible.
Replace the asterisk with a dash to maintain consistent formatting for unordered lists:
-* `rollkit` CLI installed from the [quick start](/tutorials/quick-start) tutorial. +- `rollkit` CLI installed from the [quick start](/tutorials/quick-start) tutorial.🧰 Tools
🪛 Markdownlint
28-28: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
- tutorials/celestia-da.md (3 hunks)
🧰 Additional context used
🪛 LanguageTool
tutorials/celestia-da.md
[duplication] ~44-~44: Possible typo: you repeated a word
Context: ..., let's query the DA layer start height using using our light node. ```bash DA_BLOCK_HEIGH...(ENGLISH_WORD_REPEAT_RULE)
🪛 Markdownlint
tutorials/celestia-da.md
28-28: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
🔇 Additional comments (5)
tutorials/celestia-da.md (5)
12-12: LGTM: Updated prerequisite referenceThe change to reference the "quick start" tutorial instead of the "GM world rollup" tutorial aligns well with the PR objectives and improves the tutorial's flow.
32-42: LGTM: Clear DA configuration instructionsThe updated section provides clear and concise instructions on the required DA configuration flags. The addition of information about the optional
--rollkit.da_block_timeflag is particularly helpful. This change enhances the tutorial's clarity and usefulness.
Line range hint
100-115: LGTM: Updated rollup initiation and explorer informationThe updated command for initiating the rollup node correctly incorporates the new configuration flags introduced earlier in the tutorial. The additional information on viewing the rollup using block explorers, along with the up-to-date links for different networks, is very helpful for users to verify their rollup's operation.
Line range hint
117-119: LGTM: Effective conclusionThe "Next steps" section provides a concise and encouraging conclusion to the tutorial. It effectively wraps up the guide and motivates users to continue building with their newly deployed rollup.
Line range hint
1-119: Overall: Excellent update to the Celestia DA tutorialThis update to the Celestia DA tutorial successfully achieves the PR objectives by incorporating the quick start approach and streamlining the content. The changes improve the tutorial's clarity, relevance, and ease of use for developers looking to deploy a rollup on Celestia's data availability network.
Key improvements include:
- Updated prerequisites referencing the quick start tutorial
- Simplified instructions for running a Celestia light node
- Clear explanation of DA configuration flags
- Updated commands for interacting with the Celestia network
- Relevant information on block explorers for different networks
The minor issues identified (a typo and a formatting inconsistency) can be easily addressed. Overall, this update significantly enhances the quality and usefulness of the tutorial.
🧰 Tools
🪛 LanguageTool
[duplication] ~44-~44: Possible typo: you repeated a word
Context: ..., let's query the DA layer start height using using our light node. ```bash DA_BLOCK_HEIGH...(ENGLISH_WORD_REPEAT_RULE)
🪛 Markdownlint
28-28: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (1)
tutorials/celestia-da.md (1)
28-28: LGTM: Simplified prerequisitesThe prerequisites section has been successfully streamlined to focus on the essential
rollkitCLI installation from the quick start tutorial. This change aligns well with the PR objective and simplifies the setup process for users.However, there's a minor formatting inconsistency:
To maintain consistency with Markdown formatting conventions, consider changing the asterisk to a dash:
-* `rollkit` CLI installed from the [quick start](/tutorials/quick-start) tutorial. +- `rollkit` CLI installed from the [quick start](/tutorials/quick-start) tutorial.🧰 Tools
🪛 Markdownlint
28-28: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
- tutorials/celestia-da.md (3 hunks)
🧰 Additional context used
🪛 Markdownlint
tutorials/celestia-da.md
28-28: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
🔇 Additional comments (6)
tutorials/celestia-da.md (6)
12-12: LGTM: Updated introduction with quick start referenceThe introduction has been successfully updated to reference the quick start tutorial, which aligns with the PR objective. The link is correctly formatted and provides clear guidance for users.
Line range hint
16-22: LGTM: Clarified light node setup instructionsThe updates provide clearer instructions for setting up and funding a light node across different Celestia networks. This improvement enhances the user experience and aligns with the tutorial's objectives.
However, I noticed that the mention of Mainnet Beta has been removed from the list of networks. Could you please verify if this omission is intentional? If not, consider adding it back to ensure completeness.
32-41: LGTM: Clear DA configuration instructionsThe "Configuring flags for DA" section has been effectively updated with specific instructions for the required DA configuration flags. The addition of information about the optional
--rollkit.da_block_timeflag is particularly helpful for advanced users.The changes provide clear guidance and improve the overall quality of the tutorial.
44-62: LGTM: Clear instructions for DA layer interactionThe updated commands for querying the DA layer start height and obtaining the authentication token are clear and well-explained. The inclusion of example outputs is particularly helpful for users to understand what to expect.
It's great to see that the typo mentioned in the previous review ("using using") has been addressed. This attention to detail improves the overall quality of the tutorial.
Line range hint
97-115: LGTM: Clear instructions for running the rollup and viewing resultsThe "Running your rollup connected to Celestia light node" section has been effectively updated with:
- A clear command for initiating the rollup node, including all necessary flags.
- Helpful information about viewing the rollup on block explorers.
- Up-to-date links to explorers for different Celestia networks.
These changes provide users with comprehensive guidance on running their rollup and verifying its operation, enhancing the overall tutorial experience.
Line range hint
1-124: Overall: Excellent update to the Celestia DA tutorialThis PR successfully updates the tutorial to use the quick start approach, aligning well with the stated objectives. The changes significantly improve the clarity and flow of the tutorial, making it more accessible for users.
Key improvements include:
- Streamlined introduction and prerequisites.
- Clear instructions for configuring and running the rollup with Celestia.
- Updated commands and examples for interacting with the DA layer.
- Helpful information about viewing results on block explorers.
The minor suggestions provided in the review comments will further enhance the quality of the tutorial. Great work on this update!
🧰 Tools
🪛 Markdownlint
28-28: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
Overview
Related to #480
Summary by CodeRabbit
rollkitCLI.rollkit startcommand.