fix: cleaning the docs #595
Conversation
WalkthroughThis update restructures the documentation and sidebar, removing the "Rollkit stack" page and flattening the "Technical details" section. Multiple guides are revised to replace Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Docs
participant CLI (gmd)
participant DA Network
User->>Docs: Reads updated guide
Docs-->>User: Instructs to run gmd commands
User->>CLI (gmd): Runs init/start/query commands
CLI (gmd)->>DA Network: Connects to DA as needed
CLI (gmd)-->>User: Outputs results/logs
Possibly related PRs
Suggested reviewers
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (3)
💤 Files with no reviewable changes (1)
✅ Files skipped from review due to trivial changes (1)
🚧 Files skipped from review as they are similar to previous changes (1)
✨ Finishing Touches
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 focuses on cleaning and updating the project's documentation to ensure accuracy, consistency, and ease of use for developers. The changes primarily involve updating version numbers, standardizing commands, and clarifying setup instructions, which collectively improve the onboarding experience and maintain the relevance of the guides.
Highlights
- Documentation Updates: Updated
git cloneandinstall-local-da.shcommands across guides to dynamically use{{constants.rollkitLatestTag}}, ensuring users always pull the latest recommended Rollkit version. - Version Alignment: Synchronized example output in
gm-world.mdto reflect currentIgnite CLI(v29.2.0-dev) andCosmos SDK(v0.53.0) versions, removing outdated system details. - Improved Quick Start Guide: Enhanced the quick start guide by adding explicit steps and expected output for initializing and running the local Data Availability (DA) network, making the setup process clearer for new users.
- Example Consistency: Standardized example passphrases in
quick-start.mdfrom 'verysecretpass' to 'secret' for simplicity and consistency.
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. ↩
|
There was a problem hiding this comment.
Code Review
This pull request focuses on cleaning up and improving the documentation. Key changes include replacing hardcoded version tags with a variable for easier maintenance, updating command outputs to be more generic, and adding a missing step to start the local Data Availability (DA) network in the quick-start guide. I have added suggestions regarding security best practices in the quick-start guide.
pthmas
force-pushed
the
pierrick/organize-5
branch
from
2b7a2b6 to
ff1c06d
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: 4
🔭 Outside diff range comments (1)
guides/use-tia-for-gas.md (1)
224-256: Inconsistent CLI – mixture ofrollkitandgmdcommands.The earlier sections switched to
gmd, but the key/tx queries here still userollkit. This will break copy-paste for users who only installedgmd.-ACCOUNT_ON_ROLLUP="$(rollkit keys show -a --keyring-backend test gm-key-2)" +ACCOUNT_ON_ROLLUP="$(gmd keys show -a --keyring-backend test gm-key-2)" ... -TX_HASH=$(rollkit tx bank send ... +TX_HASH=$(gmd tx bank send ... ... -rollkit q tx "$TX_HASH" +gmd q tx "$TX_HASH"
♻️ Duplicate comments (3)
guides/quick-start.md (1)
39-40: Hard-coded passphrase is insecure – add a warning or use placeholders.Re-introducing the literal
secretpassphrase repeats an earlier security concern already raised in previous reviews. At minimum add a short note that this value is for demo only and must be replaced in production, or switch to a placeholder such as<PASS_PHRASE>.guides/gm-world.md (1)
107-108: Add minimal security note for remote script execution.Same comment as in quick-start: a short disclaimer recommending manual inspection of the script before piping to
bashimproves security posture.guides/use-tia-for-gas.md (1)
30-31: Repeat security note for remote install script.Same suggestion as in other docs: advise readers to inspect the script or pin the version before piping to
bash.
🧹 Nitpick comments (11)
guides/cometbft-to-rollkit.md (2)
39-43: Fix minor grammar in the warning block
"being currently update"→"currently being updated".-This tutorial is being currently update to reflect the latest changes using the rollkit ignite app. +This tutorial is currently being updated to reflect the latest changes in the Rollkit Ignite app.
44-72: Large commented-out section may confuse readersThe tutorial after this point is fully wrapped in an HTML comment, leaving the page with only the header and the warning. If the intention is to unpublish the guide until it’s ready, consider:
- Deleting the outdated content altogether (simpler for translators & linkcheckers), or
- Moving it to a WIP branch instead of shipping commented markdown.
Either approach avoids shipping dead text that might accidentally re-surface if the comment delimiters drift.
public/install.sh (1)
89-92: Output strings are now inconsistent with the rest of the scriptYou renamed the build messages to “GM executable / gmd CLI”, but lines 44 – 52 still print “Downloading Rollkit source code” and expect
<rollkit-tag|branch>as the argument. Consider aligning all user-facing text:-print_header "Downloading Rollkit source code..." -... - print_error "Usage: install.sh <rollkit-tag|branch>"; exit 1 +print_header "Downloading GM source code..." +... + print_error "Usage: install.sh <gm-tag|branch>"; exit 1(This diff is outside the changed hunk—apply where appropriate.)
guides/da/local-da.md (1)
12-12: Spelling / style nit“setting-up” → “setting up”
-Before proceeding, ensure that you have completed the [build a chain](/guides/gm-world.md) tutorial, which covers setting-up, building and running your chain. +Before proceeding, ensure that you have completed the [build a chain](/guides/gm-world.md) tutorial, which covers setting up, building, and running your chain.guides/docker-compose.md (1)
213-214: Rename residual Rollkit references for consistencyThese lines correctly swap to
gmd, but earlier in the same guide (Dockerfile example) the install script and comments still speak of “rollkit”/rollkit CLI. A quick sweep will avoid confusing newcomers who may look for arollkitbinary after reading this page.Also applies to: 219-220, 238-238
guides/quick-start.md (2)
44-48: Grammar & clarity nit – “lets” → “let’s” and tighten the intro sentence.-First lets start the local DA network: +First, let’s start the local DA network:
49-58: Consider warning about remote install script execution.Running an unaudited shell script over HTTPS is convenient but potentially risky. Add a one-liner advising users to inspect the script or pin the commit hash when using it in CI / production.
guides/gm-world.md (3)
41-51: Example output shows “undefined” fields – add a clarifying note.
Ignite CLI build date/source hash/Buf.build versionbeingundefinedcan confuse readers. A parenthetical remark that this is expected for dev builds would help.
102-106: Grammar nit – apostrophe missing.-First lets start the local DA network: +First, let’s start the local DA network:
121-122:gmd start --rollkit.node.aggregatorwould be clearer than bare--rollkit.node.aggregator.While
--rollkit.node.aggregatoris optional for full nodes, explicitly showing the flag in aggregator tutorials maintains consistency with the rest of the docs and avoids reader confusion.guides/create-genesis.md (1)
30-40: Hard-coded user path and vague step – improve portability & clarity.
/Users/you/.gmonly applies to macOS. Suggest :-Ensure that `.gm` folder is present at `/Users/you/.gm` +Ensure that the `.gm` folder exists at `$HOME/.gm` (e.g. `/home/<user>/.gm` or `/Users/<user>/.gm`)Also explicitly state what make install builds (the gm-world binary), so readers know what to expect.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (7)
public/img/gm-world-frontend-wallet-connected.pngis excluded by!**/*.pngpublic/img/sequencing.jpgis excluded by!**/*.jpgpublic/img/transaction-flow.pngis excluded by!**/*.pngpublic/range-rollkit/alert-events.pngis excluded by!**/*.pngpublic/range-rollkit/alert-rule.pngis excluded by!**/*.pngpublic/range-rollkit/custom-network.pngis excluded by!**/*.pngpublic/range-rollkit/import-address.pngis excluded by!**/*.png
📒 Files selected for processing (13)
.vitepress/config.ts(1 hunks)guides/cometbft-to-rollkit.md(2 hunks)guides/create-genesis.md(3 hunks)guides/da/local-da.md(1 hunks)guides/docker-compose.md(2 hunks)guides/evm/single.md(1 hunks)guides/full-node.md(4 hunks)guides/gm-world.md(3 hunks)guides/quick-start.md(1 hunks)guides/use-tia-for-gas.md(3 hunks)learn/stack.md(0 hunks)learn/transaction-flow.md(0 hunks)public/install.sh(1 hunks)
💤 Files with no reviewable changes (2)
- learn/transaction-flow.md
- learn/stack.md
🧰 Additional context used
🧠 Learnings (4)
guides/quick-start.md (13)
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/hyperlane-config.yaml:1-23
Timestamp: 2024-10-08T09:26:23.244Z
Learning: In `guides/assets/hyperlane-use-tia-for-gas/hyperlane-config.yaml`, it's intentional to use the same signer phrase across multiple network configurations (`localwasm` and `stride-internal-1`).
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/hyperlane-config.yaml:1-23
Timestamp: 2024-10-11T19:05:20.591Z
Learning: In `guides/assets/hyperlane-use-tia-for-gas/hyperlane-config.yaml`, it's intentional to use the same signer phrase across multiple network configurations (`localwasm` and `stride-internal-1`).
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/hyperlane-use-tia-for-gas.md:77-82
Timestamp: 2024-10-08T09:29:26.874Z
Learning: In the 'hyperlane-use-tia-for-gas.md' guide, it is intentional to include the seed phrase directly in the code examples.
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/hyperlane-use-tia-for-gas.md:77-82
Timestamp: 2024-10-11T19:05:20.591Z
Learning: In the 'hyperlane-use-tia-for-gas.md' guide, it is intentional to include the seed phrase directly in the code examples.
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml:1-23
Timestamp: 2024-10-08T09:26:38.099Z
Learning: In `guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml`, it's intentional to use the same mnemonic for both "localwasm" and "stride-internal-1" networks.
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml:1-23
Timestamp: 2024-10-11T19:05:20.591Z
Learning: In `guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml`, it's intentional to use the same mnemonic for both "localwasm" and "stride-internal-1" networks.
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml:29-37
Timestamp: 2024-10-11T19:05:20.591Z
Learning: In `guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml`, it's intentional to set the multisig threshold to 1 and to only define validators for the `localwasm` network (domain 963).
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml:29-37
Timestamp: 2024-10-08T09:27:02.351Z
Learning: In `guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml`, it's intentional to set the multisig threshold to 1 and to only define validators for the `localwasm` network (domain 963).
Learnt from: dumbeng
PR: rollkit/docs#436
File: tutorials/artela-evm-plus-plus.md:0-0
Timestamp: 2024-10-08T18:35:32.960Z
Learning: Even testing private keys should be handled carefully in documentation to avoid promoting bad practices. It's better to use placeholders or provide instructions to generate new keys.
Learnt from: dumbeng
PR: rollkit/docs#436
File: tutorials/artela-evm-plus-plus.md:49-69
Timestamp: 2024-08-27T02:42:42.659Z
Learning: Even testing private keys should be handled carefully in documentation to avoid promoting bad practices. It's better to use placeholders or provide instructions to generate new keys.
Learnt from: dumbeng
PR: rollkit/docs#436
File: tutorials/artela-evm-plus-plus.md:0-0
Timestamp: 2024-08-27T02:53:35.650Z
Learning: Even testing private keys should be handled carefully in documentation to avoid promoting bad practices. It's better to use placeholders or provide instructions to generate new keys.
Learnt from: dumbeng
PR: rollkit/docs#436
File: tutorials/artela-evm-plus-plus.md:49-69
Timestamp: 2024-10-08T18:35:32.960Z
Learning: Even testing private keys should be handled carefully in documentation to avoid promoting bad practices. It's better to use placeholders or provide instructions to generate new keys.
Learnt from: dumbeng
PR: rollkit/docs#436
File: tutorials/artela-evm-plus-plus.md:0-0
Timestamp: 2024-10-20T19:01:50.319Z
Learning: Even testing private keys should be handled carefully in documentation to avoid promoting bad practices. It's better to use placeholders or provide instructions to generate new keys.
guides/full-node.md (4)
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.
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml:29-37
Timestamp: 2024-10-08T09:27:02.351Z
Learning: In `guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml`, it's intentional to set the multisig threshold to 1 and to only define validators for the `localwasm` network (domain 963).
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml:29-37
Timestamp: 2024-10-11T19:05:20.591Z
Learning: In `guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml`, it's intentional to set the multisig threshold to 1 and to only define validators for the `localwasm` network (domain 963).
guides/use-tia-for-gas.md (10)
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.
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/hyperlane-config.yaml:1-23
Timestamp: 2024-10-08T09:26:23.244Z
Learning: In `guides/assets/hyperlane-use-tia-for-gas/hyperlane-config.yaml`, it's intentional to use the same signer phrase across multiple network configurations (`localwasm` and `stride-internal-1`).
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/hyperlane-config.yaml:1-23
Timestamp: 2024-10-11T19:05:20.591Z
Learning: In `guides/assets/hyperlane-use-tia-for-gas/hyperlane-config.yaml`, it's intentional to use the same signer phrase across multiple network configurations (`localwasm` and `stride-internal-1`).
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml:29-37
Timestamp: 2024-10-08T09:27:02.351Z
Learning: In `guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml`, it's intentional to set the multisig threshold to 1 and to only define validators for the `localwasm` network (domain 963).
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml:29-37
Timestamp: 2024-10-11T19:05:20.591Z
Learning: In `guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml`, it's intentional to set the multisig threshold to 1 and to only define validators for the `localwasm` network (domain 963).
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/hyperlane-use-tia-for-gas.md:77-82
Timestamp: 2024-10-08T09:29:26.874Z
Learning: In the 'hyperlane-use-tia-for-gas.md' guide, it is intentional to include the seed phrase directly in the code examples.
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/hyperlane-use-tia-for-gas.md:77-82
Timestamp: 2024-10-11T19:05:20.591Z
Learning: In the 'hyperlane-use-tia-for-gas.md' guide, it is intentional to include the seed phrase directly in the code examples.
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml:1-23
Timestamp: 2024-10-11T19:05:20.591Z
Learning: In `guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml`, it's intentional to use the same mnemonic for both "localwasm" and "stride-internal-1" networks.
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml:1-23
Timestamp: 2024-10-08T09:26:38.099Z
Learning: In `guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml`, it's intentional to use the same mnemonic for both "localwasm" and "stride-internal-1" networks.
guides/create-genesis.md (2)
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml:29-37
Timestamp: 2024-10-08T09:27:02.351Z
Learning: In `guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml`, it's intentional to set the multisig threshold to 1 and to only define validators for the `localwasm` network (domain 963).
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml:29-37
Timestamp: 2024-10-11T19:05:20.591Z
Learning: In `guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml`, it's intentional to set the multisig threshold to 1 and to only define validators for the `localwasm` network (domain 963).
🪛 LanguageTool
guides/quick-start.md
[grammar] ~44-~44: Ensure spelling is correct
Context: ...reign rollup node Now that we have our testapp generated and installed, we can launch ...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
🔇 Additional comments (3)
.vitepress/config.ts (1)
190-191: LGTM! Documentation navigation simplified effectively.The flattening of the "Technical details" section and promotion of "Transaction flow" and "Configuration" as direct items under "Learn" improves navigation clarity. This change aligns well with the PR's goal of cleaning up and streamlining the documentation structure.
guides/evm/single.md (1)
20-22: Good call switching to the constant tagUsing
{{constants.rollkitLatestTag}}keeps the docs evergreen. Just ensure the constant is defined in.vitepress/constants/constants.jsbefore merging.guides/create-genesis.md (1)
48-50: Verify sub-command: iscomet unsafe-reset-allstill valid?Recent Rollkit versions renamed this to
tendermint unsafe-reset-all. Please confirm and update to avoid copy-paste errors.
pthmas
force-pushed
the
pierrick/organize-5
branch
from
ff1c06d to
076bd74
Compare
pthmas
force-pushed
the
pierrick/organize-5
branch
from
076bd74 to
a5b2aca
Compare
Overview
I would suggest reviewing commit by commit, as it will make more sense: this PR is an aggregation of multiple unrelated changes to small to have their own PR.
Summary by CodeRabbit
Documentation
gmdcommand instead of the Rollkit CLI, reflecting changes in setup and usage instructions.Style
gmdCLI for consistency.