fix: da tutorials #580
fix: da tutorials #580
Conversation
WalkthroughThe updates remove the "Use Ignite to create a Rollkit app" guide from the sidebar and revise tutorials to reference the "gm-world" tutorial instead of "quick start," update CLI usage from Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Tutorial
participant CLI (gmd)
participant Rollup Node
User->>Tutorial: Follow updated instructions (gm-world, gmd)
Tutorial->>User: Provide gmd commands with new flags
User->>CLI (gmd): Execute updated start command
CLI (gmd)->>Rollup Node: Start rollup node with new aggregator flag
Possibly related PRs
Suggested reviewers
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. 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 (
|
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @pthmas, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request cleans up the documentation by removing a stale link in the sidebar menu and removing an unnecessary flag from a command in the local DA tutorial, improving the user experience.
Highlights
- Menu Update: Removed the 'Use Ignite to create a Rollkit app' link from the 'How To Guides' section in the sidebar configuration.
- Tutorial Update: Removed the
--rollkit.sequencer_rollup_id gmdflag from the example command in the local-da.md tutorial.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
pthmas
force-pushed
the
pierrick/fix-tutorials
branch
from
5d4590f to
6836fde
Compare
pthmas
force-pushed
the
pierrick/fix-tutorials
branch
from
f1a20db to
bfe5006
Compare
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (1)
tutorials/da/local-da.md (1)
38-41: Aggregator flag updated, but removed sequencer flag—double-check behavioural change
--rollkit.node.aggregatorreplaces--rollkit.aggregator, and the earlier--rollkit.sequencer_rollup_id gmdline is now gone. Ensure the sequencer flag really became obsolete; if not, note where it is now configured to prevent silent mis-configuration.
🧹 Nitpick comments (2)
tutorials/da/celestia-da.md (2)
47-47: Clarify which binary installsgmdReaders coming from older material may still have
rollkiton their PATH. A short reminder thatgmdis installed by runningmake installin the gm-world tutorial (or the exact command) avoids confusion.
133-138: Explain the purpose of--rollkit.node.aggregatorDropping a bare boolean flag with no context may confuse newcomers (is it mandatory? why?). Adding a one-sentence comment, e.g. “The flag turns the node into the block aggregator; omit it if you run a non-aggregator node,” would tighten up the tutorial.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
.vitepress/config.ts(0 hunks)tutorials/da/celestia-da.md(3 hunks)tutorials/da/local-da.md(1 hunks)
💤 Files with no reviewable changes (1)
- .vitepress/config.ts
🧰 Additional context used
🧠 Learnings (1)
tutorials/da/local-da.md (2)
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/relayer.json:1-5
Timestamp: 2024-10-11T19:05:20.591Z
Learning: In the file `guides/assets/hyperlane-use-tia-for-gas/relayer.json`, the settings `"allowLocalCheckpointSyncers": "true"` and `"gasPaymentEnforcement": [{ "type": "none" }]` are intentional.
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/relayer.json:1-5
Timestamp: 2024-10-08T09:25:31.642Z
Learning: In the file `guides/assets/hyperlane-use-tia-for-gas/relayer.json`, the settings `"allowLocalCheckpointSyncers": "true"` and `"gasPaymentEnforcement": [{ "type": "none" }]` are intentional.
🔇 Additional comments (2)
tutorials/da/celestia-da.md (2)
12-12: Verify link accuracy after quick-start → gm-world switch
/tutorials/gm-worldlooks correct, but please double-check that the page exists and the anchor IDs referenced from this tutorial still resolve, otherwise users will 404 at the very first step.
53-58: Flag names updated → confirm they match the current binaryThe doc now uses the dotted notation (
--rollkit.da.*). Make sure every releasedgmdtag listed inconstants.jsactually exposes these flags; older nightly builds still expect the underscore form.
pthmas
force-pushed
the
pierrick/fix-tutorials
branch
from
bfe5006 to
97c5031
Compare
Overview
Summary by CodeRabbit
rollkittogmd.