Add Quick Start tutorial #357
Conversation
WalkthroughThe recent changes focus on enhancing user guidance and simplifying tool installations. A new "Quick Start" guide enriches the documentation, improving user onboarding. Updates to scripts automate Go and Rollkit installations, streamlining the setup process for a smoother user experience. Changes
Recent Review DetailsConfiguration used: CodeRabbit UI Files selected for processing (5)
Files skipped from review as they are similar to previous changes (3)
Additional Context UsedShellCheck (4)
Additional comments not posted (2)
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 as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
|
Will wait for Samuel to provide me with answer regarding pointing install.rollkit.dev to install-rollkit.sh script |
|
yarikbratashchuk
force-pushed
the
yarik/quick-start
branch
from
92c058a to
82a5cb2
Compare
yarikbratashchuk
force-pushed
the
yarik/quick-start
branch
from
82a5cb2 to
71e3c14
Compare
|
As rollkit is using git, we have to use git instead of downloading a release |
yarikbratashchuk
force-pushed
the
yarik/quick-start
branch
from
71e3c14 to
f68834e
Compare
- add script for installing Go from source, platform agnostic - add script for installing Rollkit cli by building it from source under the hood
yarikbratashchuk
force-pushed
the
yarik/quick-start
branch
from
f68834e to
7207b81
Compare
yarikbratashchuk
requested review from
MSevey and
jcstein
and removed request for
MSevey
|
@MSevey, are you okay with using install.rollkit.dev for cli installation script? |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
Out of diff range and nitpick comments (1)
scripts/install-go.sh (1)
108-113: Document the limitation regarding the dynamic sourcing of shell configuration files.Consider adding a comment in the script to inform users that changes might not take effect immediately in all scenarios due to the dynamic nature of sourcing configuration files.
| ```bash | ||
| curl -s https://install.rollkit.dev | sh | ||
| ``` |
There was a problem hiding this comment.
Consider enhancing the security of the installation command.
- curl -s https://install.rollkit.dev | sh
+ curl -s https://install.rollkit.dev -o rollkit_install.sh
+ sh rollkit_install.shThis change allows the user to review the script before executing it, reducing the risk of executing malicious code.
Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| ```bash | |
| curl -s https://install.rollkit.dev | sh | |
| ``` | |
| ```bash | |
| curl -s https://install.rollkit.dev -o rollkit_install.sh | |
| sh rollkit_install.sh |
</details>
<!-- suggestion_end -->
<!-- This is an auto-generated comment by CodeRabbit -->
|
|
||
| Welcome to Rollkit, a sovereign rollup framework! The easiest way to launch your sovereign rollup node is by using the Rollkit CLI. | ||
|
|
||
| ### 📦 Install Rollkit (CLI) |
There was a problem hiding this comment.
Adjust the heading level for consistency.
- ### 📦 Install Rollkit (CLI)
+ ## 📦 Install Rollkit (CLI)This change ensures that heading levels increment by one level at a time, maintaining a logical structure in the document.
Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| ### 📦 Install Rollkit (CLI) | |
| ## 📦 Install Rollkit (CLI) |
|
closing due to fixes in the #360 |
The most basic tutorial for running sovereign rollup node without knowing anything (da/consensus/config/etc.)
Closes: #361
Summary by CodeRabbit