fix: quick start guide #578
Conversation
![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 updates the quick start guide documentation to align with the current tooling, specifically transitioning from the deprecated Rollkit CLI to the Testapp CLI. This ensures that new users follow the correct and up-to-date procedures for setting up and running a sovereign rollup node, including a new initialization step and updated command syntax.
Highlights
- Documentation Update: The quick start guide has been updated to reflect the deprecation of
Rollkit CLIand the adoption ofTestapp CLIfor launching sovereign rollup nodes. This includes changes to the page description and introductory text. - CLI Command Migration: All
rollkitCLI commands in the quick start guide (e.g.,rollkit version,rollkit start) have been replaced with theirtestappequivalents. Thetestapp startcommand now includes additional necessary flags. - New Initialization Step: A new section titled 'Initialize a sovereign rollup node' has been added to the guide, providing instructions and the
testapp initcommand for setting up a node.
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. ↩
WalkthroughReferences in the quick-start tutorial were updated from "Rollkit CLI" to "Testapp CLI," including installation, command usage, and headings. Example outputs and command flags were adjusted to reflect the new CLI. A section was added to demonstrate initializing a node with the updated command syntax. Changes
Suggested reviewers
Poem
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 (
|
|
There was a problem hiding this comment.
Code Review
The pull request updates the quick start guide to use the Testapp CLI instead of the deprecated Rollkit CLI. However, some parts of the guide still refer to Rollkit, which could cause confusion. The review focuses on ensuring all references are consistently updated to Testapp.
![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
🧹 Nitpick comments (2)
tutorials/quick-start.md (2)
21-25: Version-check prose is inconsistent
The description still says “check the Rollkit version” while the command usestestapp version.Suggested tweak:
-Verify the installation by checking the Rollkit version: +Verify the installation by checking the Testapp version:Keeps terminology consistent.
34-40: Flag usage could use a brief explanation
--rollkit.node.aggregatoris passed without=true/false, which might confuse newcomers. Consider adding a one-liner explaining it is a boolean flag enabling aggregator mode, and that--rollkit.signer.passphrasereads the string literally (no prompt).
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
tutorials/quick-start.md(3 hunks)
🔇 Additional comments (1)
tutorials/quick-start.md (1)
13-18: ```shell
#!/usr/bin/env bash
set -eLocate the constants file
constants_file=$(fd --hidden --color=never constants.js | grep ".vitepress/constants/constants.js" | head -n1)
echo "Found constants file: $constants_file"Display its contents
sed -n '1,200p' "$constants_file"
</details> </blockquote></details> </details> <!-- This is an auto-generated comment by CodeRabbit for review status -->
| To initialize a sovereign rollup node, execute the following command: | ||
|
|
||
| ```bash | ||
| testapp init --rollkit.node.aggregator --rollkit.signer.passphrase verysecretpass |
There was a problem hiding this comment.
Without the flags, the genesis.json file doesn't have a proposer_address generated. Maybe someone knows a better way to do it?
Overview
Fix the quick start guide, which uses the Testapp CLI instead of the deprecated Rollkit CLI.
Summary by CodeRabbit