chore: update docs for v1 (1/n) #564
Conversation
WalkthroughThis update restructures and consolidates Rollkit's documentation by removing numerous individual configuration and tutorial guides, introducing new comprehensive guides for configuration and EVM sequencer setups, updating navigation, and revising several tutorials for clarity and consistency. The changes focus on centralizing configuration information and modernizing setup instructions. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Docs
participant Rollkit Node
participant EVM Layer
participant DA Node
User->>Docs: Accesses new config or EVM sequencer guide
User->>Rollkit Node: Builds and configures node using guide
User->>DA Node: Starts DA node as instructed
User->>EVM Layer: Starts EVM execution layer (op-geth/reth)
User->>Rollkit Node: Starts sequencer/full node with flags from guide
Rollkit Node->>DA Node: Connects for data availability
Rollkit Node->>EVM Layer: Connects for execution
User->>Rollkit Node: Verifies operation via logs/metrics
Poem
Note ⚡️ AI Code Reviews for VS Code, Cursor, WindsurfCodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback. Note ⚡️ Faster reviews with cachingCodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure 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 (
|
|
tac0turtle
force-pushed
the
marko/update-docs
branch
from
51caf3f to
9e8b27f
Compare
tac0turtle
force-pushed
the
marko/update-docs
branch
from
3eed836 to
d90c9bc
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
🧹 Nitpick comments (27)
guides/create-genesis.md (3)
5-5: Remove trailing whitespace and fix spelling in heading.
Good removal of trailing whitespace on this heading. However, "Pre-requisities" is misspelled; consider using "Prerequisites" (no hyphen) for consistency and correctness.
7-7: Add comma after introductory phrase.
Add a comma after "For this guide" to improve readability:-For this guide you need to have a chain directory... +For this guide, you need to have a chain directory...
12-12: Include missing article "the".
In "created in linked guide.", add "the" before "linked" for grammatical correctness:-This guide will use the simple ignite chain created in linked guide. +This guide will use the simple ignite chain created in the linked guide.🧰 Tools
🪛 LanguageTool
[uncategorized] ~12-~12: You might be missing the article “the” here.
Context: ... use the simple ignite chain created in linked guide. Make sure to update any relevant...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
learn/stack.md (1)
101-101: Add missing comma for clarity
Insert a comma after “specified” to improve readability:- If no height is specified the latest block will be used. + If no height is specified, the latest block will be used.🧰 Tools
🪛 LanguageTool
[typographical] ~101-~101: It seems that a comma is missing.
Context: ...of the requested block. If no height is specified the latest block will be used. If heigh...(IF_COMMA)
guides/reset-state.md (1)
10-10: Grammar refinement
Consider rephrasing for clarity:- Some reason you might need to reset the state of your chain are: + Some reasons you might need to reset the state of your chain include:tutorials/sequencing/overview.md (4)
2-4: Remove leading whitespace.
Line 4 begins with an extra space before “Sequencing is…”, which can affect Markdown rendering and consistency. Please remove the leading space.
8-16: Clarify interface method signatures.
Consider including Go parameter and return types in the snippet (e.g.SubmitRollupTransaction(rollupID string, data []byte) error GetNextBatch(rollupID string, lastBatchHash []byte, maxBytes int) (Batch, time.Time) VerifyBatch(rollupID string, batchHash []byte) (Status, error)) so readers know expected types. Also, add periods at the end of each method line to keep punctuation consistent.
20-23: Add terminal periods to bullets.
The list under “It mainly consists of:” is missing periods at the end of each item. Adding them improves readability and maintains style consistency.
26-27: Simplify wording and fix missing article.
- Change “refactored functionality from the Rollkit prior to
v1.0.0” to “refactored from Rollkit beforev1.0.0”.- Add “the” before “single sequencer”: “…relays rollup transactions to the single sequencer…”.
🧰 Tools
🪛 LanguageTool
[style] ~26-~26: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ...factored functionality from the Rollkit prior tov1.0.0. The single sequencer is the m...(EN_WORDINESS_PREMIUM_PRIOR_TO)
[uncategorized] ~26-~26: You might be missing the article “a” here.
Context: ...ator node relays rollup transactions to single sequencer which then submits them to th...(AI_EN_LECTOR_MISSING_DETERMINER_A)
guides/evm-single-guide.md (5)
21-23: Specify shell language for code block.
Wrap thegit clonecommands in a fenced block labelledbashorshellfor proper syntax highlighting, e.g.git clone https://github.com/rollkit/rollkit.git cd rollkit
28-30: Specify shell language for code block.
Themake build-evm-singleandmake build-dacommands should also be in abash/shellfenced block to improve clarity.
42-44: Specify shell language for code block.
Starting the local DA node commands should be wrapped in abash/shellcode fence.
52-56: Specify shell language for code block.
Cloning thego-execution-evmrepository would benefit from abashcode fence to distinguish commands from prose.
82-88: Link to unified configuration reference.
Consider adding a reference to the consolidated Config Settings guide here, so readers can look up flag descriptions and defaults without leaving this guide.guides/evm-based.md (3)
21-23: Specify shell language for code block.
Thegit clonesnippet should be wrapped in abash/shellfenced code block for consistency.
28-30: Specify shell language for code block.
Wrap themake build-evm-basedandmake build-dacommands in abash/shellcode fence.
126-136: Specify shell language for code block.
The full node start command should be in abashcode fence to improve readability.guides/metrics.md (3)
3-4: Reconsider subsection title.
Under “Rollkit Metrics Guide,” the heading “## How to configure metrics” could be more descriptive as “## Enabling Prometheus metrics” to match its content.
9-12: Show YAML snippet in fenced block.
Display the setting for enabling metrics in a fencedyamlblock, for example:instrumentation: prometheus: true
57-63: Label code fence language for curl.
Wrap thecurl http://localhost:26660/metricsexample in abash/shellfenced block for proper syntax highlighting.guides/config.md (3)
52-59: Align section title with TOC.
Rename the section header from## Configsto## Introduction to Configurationsso it matches the TOC entry and clarifies purpose.
761-766: Simplify wording.
Replace “used in conjunction with” with a shorter alternative like “used with” or “used alongside” to reduce wordiness.🧰 Tools
🪛 LanguageTool
[style] ~761-~761: ‘in conjunction with’ might be wordy. Consider a shorter alternative.
Context: ...n theSignerConfigstruct but is used in conjunction with it. YAML: This is typically not st...(EN_WORDINESS_PREMIUM_IN_CONJUNCTION_WITH)
43-350: Add language identifiers to code blocks.
Many YAML and shell examples lack language tags on their fences. For better readability and syntax highlighting, annotate YAML snippets withyamland shell commands withbashorshell.tutorials/da/overview.md (4)
13-13: Use a versioned link for the DA interface
The link to the core DA interface currently points at themainbranch (.../blob/main/...). Since this documentation is being updated for v1, you should point to the v1 tag (or a versioned path) to prevent the link from drifting whenmainchanges.
17-17: Rephrase the interface overview for clarity
The phrase “Probably the two most important functions” sounds informal and downplays the expanded interface. Consider removing “Probably” and explicitly listing the core methods or pointing readers to the full interface below.
22-56: Document the expanded DA interface in detail
The DA interface has grown to include methods beyondGetandSubmit(e.g.,MaxBlobSize,GetIDs,GetProofs,Commit,SubmitWithOptions,Validate,GasPrice,GasMultiplier). To improve usability:
- Add a brief description (or a table) summarizing each new method’s purpose.
- Group related methods (reads vs. writes vs. utility) for better readability.
- Ensure types like
ID,Blob,Commitment, and the[]byte-namespaceparameter are linked or documented elsewhere.- Verify the opening and closing ```go fences are correctly labeled.
60-60: Fix the Celestia DA link and label
The reference[Celestia](celestia-da)lacks context and may not resolve as intended. Change it to something like[Celestia DA](celestia-da.md)or use a relative path (../da/celestia-da.md) and include “DA” in the link text for clarity.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (34)
guides/block-times.md(0 hunks)guides/config.md(1 hunks)guides/create-genesis.md(2 hunks)guides/da-block-time.md(0 hunks)guides/evm-based.md(1 hunks)guides/evm-single-guide.md(1 hunks)guides/full-node.md(0 hunks)guides/gas-price.md(2 hunks)guides/lazy-sequencing.md(0 hunks)guides/max-pending-blocks.md(0 hunks)guides/metrics.md(1 hunks)guides/overview.md(1 hunks)guides/reset-state.md(2 hunks)guides/rollkit-monitoring.md(0 hunks)guides/use-rollkit-cli.md(0 hunks)learn/stack.md(1 hunks)tutorials/da/avail-da.md(0 hunks)tutorials/da/celestia-da.md(2 hunks)tutorials/da/local-da.md(4 hunks)tutorials/da/overview.md(1 hunks)tutorials/deploy-overview.md(1 hunks)tutorials/execution/artela-evm-plus-plus.md(0 hunks)tutorials/execution/beaconkit.md(0 hunks)tutorials/execution/cosmwasm.md(7 hunks)tutorials/execution/evm-contract-interaction.md(0 hunks)tutorials/execution/octane-evm.md(0 hunks)tutorials/execution/polaris-evm.md(0 hunks)tutorials/kurtosis.md(0 hunks)tutorials/sequencing/astria.md(0 hunks)tutorials/sequencing/based.md(1 hunks)tutorials/sequencing/centralized.md(0 hunks)tutorials/sequencing/forced-inclusion.md(1 hunks)tutorials/sequencing/local.md(0 hunks)tutorials/sequencing/overview.md(2 hunks)
💤 Files with no reviewable changes (17)
- tutorials/sequencing/astria.md
- guides/max-pending-blocks.md
- guides/block-times.md
- guides/lazy-sequencing.md
- guides/use-rollkit-cli.md
- guides/da-block-time.md
- tutorials/execution/artela-evm-plus-plus.md
- tutorials/sequencing/local.md
- tutorials/execution/evm-contract-interaction.md
- guides/rollkit-monitoring.md
- tutorials/kurtosis.md
- guides/full-node.md
- tutorials/execution/octane-evm.md
- tutorials/sequencing/centralized.md
- tutorials/execution/beaconkit.md
- tutorials/execution/polaris-evm.md
- tutorials/da/avail-da.md
🧰 Additional context used
🪛 LanguageTool
guides/create-genesis.md
[typographical] ~6-~6: Use a comma after an introductory phrase.
Context: ...tart the chain. ## 0. Pre-requisities For this guide you need to have a chain directory wher...
(COMMA_INTRODUCTORY_WORDS_PHRASES)
[uncategorized] ~12-~12: You might be missing the article “the” here.
Context: ... use the simple ignite chain created in linked guide. Make sure to update any relevant...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
guides/reset-state.md
[style] ~16-~16: Consider a more concise word here.
Context: ... changes * Hardforks ## Prerequisites In order to complete this guide, you will need to h...
(IN_ORDER_TO_PREMIUM)
learn/stack.md
[typographical] ~101-~101: It seems that a comma is missing.
Context: ...of the requested block. If no height is specified the latest block will be used. If heigh...
(IF_COMMA)
tutorials/sequencing/overview.md
[style] ~26-~26: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ...factored functionality from the Rollkit prior to v1.0.0. The single sequencer is the m...
(EN_WORDINESS_PREMIUM_PRIOR_TO)
[uncategorized] ~26-~26: You might be missing the article “a” here.
Context: ...ator node relays rollup transactions to single sequencer which then submits them to th...
(AI_EN_LECTOR_MISSING_DETERMINER_A)
guides/config.md
[style] ~761-~761: ‘in conjunction with’ might be wordy. Consider a shorter alternative.
Context: ...n the SignerConfig struct but is used in conjunction with it. YAML: This is typically not st...
(EN_WORDINESS_PREMIUM_IN_CONJUNCTION_WITH)
🪛 markdownlint-cli2 (0.17.2)
guides/config.md
7-7: Link fragments should be valid
null
(MD051, link-fragments)
🔇 Additional comments (26)
guides/create-genesis.md (1)
53-53: Ensure proper separation after code block.
The added blank line after the triple backticks improves Markdown rendering by separating the code block from the surrounding text. LGTM.tutorials/sequencing/forced-inclusion.md (1)
3-3: Trivial whitespace update
A newline was added after the placeholder text. This ensures the file ends with a single newline, which is a good POSIX practice.tutorials/sequencing/based.md (1)
1-1: Title formatting corrected
Removed the extra space in the heading (# Based Sequencing) to standardize Markdown syntax. Looks good.tutorials/da/celestia-da.md (2)
47-47: Removed trailing space in bullet
The trailing space after the prerequisite bullet was cleaned up for consistency.
146-146: Inserted blank line for readability
A blank line was added before the “Other explorers” list to improve Markdown rendering.guides/reset-state.md (3)
15-15: Heading placement approved
The new “## Prerequisites” heading is well positioned and consistent with other guides.
21-21: Instruction description approved
The explanatory sentence about.rollkitcreation is clear and accurate.
23-23: Directory preview caption approved
“This directory will look like the following.” accurately introduces the tree output.tutorials/execution/cosmwasm.md (4)
33-33: Whitespace formatting cleanup
Removed trailing spaces from the sentence enhances markdown consistency without affecting content.
40-40: Add blank line after code block
Inserting a blank line after the code block improves readability and ensures proper rendering.
124-124: Remove trailing spaces in code snippet delimiter
Cleaning up trailing spaces in the fenced code block maintains consistency across examples.
134-134: Remove trailing spaces in code snippet delimiter
Minor formatting fix that does not impact tutorial steps.tutorials/deploy-overview.md (2)
9-9: Remove trailing whitespace
Formatting-only change; no effect on tutorial content.
11-11: Remove trailing whitespace
Minor fix to improve markdown cleanliness.guides/gas-price.md (2)
7-11: Flag syntax and example prefix updated
The documentation correctly changes the flag from--rollkit.da_gas_priceto--rollkit.da.gas_priceand generalizes the binary name to${BINARY_NAME}. This aligns with the standardized configuration reference.
19-23: Gas multiplier flag syntax and example prefix updated
The flag--rollkit.da_gas_multiplieris now--rollkit.da.gas_multiplier, and the example uses${BINARY_NAME}. This is consistent with the new naming conventions.tutorials/da/local-da.md (4)
10-10: Clarify tutorial scope
Updating the introduction to reference the local-da repo directly improves context for readers.
26-26: Correct flag naming in description
Refers to--rollkit.da.address, matching the new dot-notation convention.
50-52: Expanded log output for clarity
Replacing a single-line log with the full initialization sequence helps users verify all startup steps.
57-57: Add link to local-da README
Including a reference to the binary’s README enriches the summary with actionable resources.guides/overview.md (3)
20-20: Add reset-state guide link
Including theReset your chain's statelink aligns the overview with the new unsafe-clean command guide.
23-25: Introduce EVM Rollups section
New EVM Rollups entries correctly point to theevm-basedandevm-single-guidesetup guides.
27-27: Consolidate configuration reference
Linking to the unifiedConfig Settingsguide replaces multiple granular config docs for consistency.guides/evm-based.md (1)
82-94: Include--based.authflag or clarify optionality.
Inconfig.md, there’s a--based.authoption for DA authentication, but this example omits it. Please confirm if an auth token is required and, if so, show how to supply it here.guides/metrics.md (2)
21-26: Verify metric name prefixes.
Block Manager metrics userollkit_sequencer_*, while Single Sequencer metrics drop therollkit_prefix. Clarify whether all metrics are exposed asrollkit_<name>or adjust the documentation to reflect actual metric names.
83-89: Inconsistent default port.
This guide states the default metrics port is 26660, butconfig.mdlists the Prometheus default as":2112". Please verify the correct default and align both documents.
| @@ -44,7 +45,7 @@ tree $HOME/.rollkit | |||
| To reset the state of the chain, delete the entire `.rollkit` directory. | |||
|
|
|||
| ```bash | |||
| rm -rf $HOME/.rollkit | |||
| ${BINARY} unsafe-clean | |||
There was a problem hiding this comment.
🛠️ Refactor suggestion
Clarify placeholder variable
Referencing ${BINARY} without definition can confuse readers. Recommend replacing it with the actual command or explaining the placeholder:
-${BINARY} unsafe-clean
+rollkit unsafe-clean📝 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. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ${BINARY} unsafe-clean | |
| rollkit unsafe-clean |
| {BINARY} start --rollkit.da_address http://localhost:7980 | ||
| ``` | ||
|
|
||
| ```sh [Wordle Chain] | ||
| rollkit start \ | ||
| {BINARY} start \ | ||
| --rollkit.aggregator \ | ||
| --rollkit.da_address http://localhost:7980 \ | ||
| --rollkit.sequencer_rollup_id wordle |
There was a problem hiding this comment.
Inconsistent flag usage in code snippet
The snippet still uses --rollkit.da_address (underscore) but the description expects --rollkit.da.address (dot). Please update both Quick Start and Wordle Chain examples:
- {BINARY} start --rollkit.da_address http://localhost:7980
+ {BINARY} start --rollkit.da.address http://localhost:7980
- --rollkit.da_address http://localhost:7980 \
+ --rollkit.da.address http://localhost:7980 \📝 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. Thoroughly test & benchmark the code to ensure it meets the requirements.
| {BINARY} start --rollkit.da_address http://localhost:7980 | |
| ``` | |
| ```sh [Wordle Chain] | |
| rollkit start \ | |
| {BINARY} start \ | |
| --rollkit.aggregator \ | |
| --rollkit.da_address http://localhost:7980 \ | |
| --rollkit.sequencer_rollup_id wordle |
| - [Introduction to Configurations](#introduction-to-configurations) | ||
| - [Base Configuration](#base-configuration) | ||
| - [Root Directory](#root-directory) | ||
| - [Database Path](#database-path) | ||
| - [Chain ID](#chain-id) | ||
| - [Node Configuration (`node`)](#node-configuration-node) | ||
| - [Aggregator Mode](#aggregator-mode) | ||
| - [Light Client Mode](#light-client-mode) | ||
| - [Block Time](#block-time) |
There was a problem hiding this comment.
Invalid TOC fragment.
The TOC references “Introduction to Configurations” (#introduction-to-configurations), but no such heading exists. Update the TOC or add/rename a corresponding section.
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
7-7: Link fragments should be valid
null
(MD051, link-fragments)
|
|
||
| ## Go DA {#go-da} | ||
| ## DA {#go-da} |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Align section anchor with the heading
The anchor {#go-da} no longer matches the new heading “DA.” This mismatch can break intra-doc links. Rename the anchor to {#da} (or a more descriptive identifier) to keep your links accurate.
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
tutorials/gm-world.md (1)
77-77: Fix missing apostrophe in textThere's a grammatical error in the instruction text.
-First lets start the local DA network: +First let's start the local DA network:🧰 Tools
🪛 LanguageTool
[uncategorized] ~77-~77: It seems likely that a singular genitive (’s) apostrophe is missing.
Context: ...y running the following command: First lets start the local DA network: ```bash cu...(AI_HYDRA_LEO_APOSTROPHE_S_XS)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (2)
package-lock.jsonis excluded by!**/package-lock.jsonyarn.lockis excluded by!**/yarn.lock,!**/*.lock
📒 Files selected for processing (6)
.vitepress/config.ts(4 hunks)guides/overview.md(1 hunks)package.json(0 hunks)public/install-local-da.sh(1 hunks)tutorials/gm-world.md(6 hunks)tutorials/sequencing/single.md(1 hunks)
💤 Files with no reviewable changes (1)
- package.json
✅ Files skipped from review due to trivial changes (1)
- tutorials/sequencing/single.md
🚧 Files skipped from review as they are similar to previous changes (1)
- guides/overview.md
🧰 Additional context used
🪛 LanguageTool
tutorials/gm-world.md
[uncategorized] ~77-~77: It seems likely that a singular genitive (’s) apostrophe is missing.
Context: ...y running the following command: First lets start the local DA network: ```bash cu...
(AI_HYDRA_LEO_APOSTROPHE_S_XS)
🔇 Additional comments (20)
public/install-local-da.sh (1)
8-8: Updated build command for local-daThe build command was updated from
make buildtomake build-dato align with the updated build targets in the Rollkit repository.tutorials/gm-world.md (15)
32-32: Updated tooling from Kurtosis to IgniteThe tutorial now uses Ignite instead of Kurtosis for managing services, which aligns with the broader documentation update toward Ignite-based workflows.
37-52: Updated version verification command outputThe output example for Ignite's version command provides clear information about the installed version and system requirements.
57-59: Updated chain generation commandsThe chain generation now uses Ignite's scaffolding commands instead of previous Kurtosis-based approach.
61-71: Added Ignite app installation stepsNew steps have been added for installing a specific version of the Ignite Rollkit app from GitHub, followed by local installation.
73-76: Updated rollup startup sectionThe section clearly introduces the updated workflow for launching the GM rollup with the local DA network.
80-80: Updated local DA installation commandThe command now uses the installation script from rollkit.dev, including a version tag from constants.
86-89: Updated local DA log exampleThe log output example has been updated to reflect the current behavior of the local DA implementation.
94-94: Updated rollup start commandThe command now directly uses
gmd startwith the Rollkit aggregator flag instead of running inside a Docker container.
99-124: Updated log output exampleThe updated log output provides a comprehensive example of what users should expect when starting their rollup with the new command.
126-127: Updated port informationThe documentation now correctly reflects the ports used by the GM rollup (7331) and local DA network (7980).
135-136: Updated CLI command for key listingThe command has been updated to use
gmd keys listinstead of the previous approach.
161-161: Updated transaction submission commandThe command now uses
gmd tx bank sendwith appropriate flags for the new tooling.
204-204: Updated balance query commandThe command has been updated to use
gmd query bank balancesinstead of the previous approach.
221-221: Updated second balance query commandConsistent update to use
gmd query bank balancesfor checking the sender's balance.
235-253: Commented out UI app sectionThe GM world UI app section related to Kurtosis has been commented out since it's no longer applicable with the move to Ignite-based workflow.
.vitepress/config.ts (4)
220-220: Updated "Build a chain" tutorial linkThe tutorial link has been updated from "/tutorials/wordle" to "/tutorials/gm-world" to reflect the documentation restructuring.
248-249: Consolidated sequencing tutorialsThe "Local" and "Centralized" sequencing tutorials have been replaced with a single "Single" tutorial, simplifying the documentation structure.
270-270: Commented out RETH EVM tutorial linkThe RETH EVM tutorial link has been commented out, likely because it's not ready or being replaced.
321-321: Consolidated configuration guidesThe configuration guides have been consolidated into a single "/guides/config" link instead of multiple separate guides, simplifying the documentation structure.
| @@ -1,10 +1,10 @@ | |||
| #!/bin/bash | |||
|
|
|||
| echo "Downloading Local-DA source code..." | |||
| git clone https://github.com/rollkit/local-da.git | |||
| git clone https://github.com/rollkit/rollkit.git | |||
There was a problem hiding this comment.
Repository change for local-da script
The script now clones from the Rollkit repository instead of the previously used local-da repository.
There's a potential issue: after cloning the rollkit repository on line 4, the script attempts to cd into local-da on line 5, which might not exist in the new repository structure. This could cause the script to fail.
-git clone https://github.com/rollkit/rollkit.git
+git clone https://github.com/rollkit/rollkit.git
+cd rollkit || { echo "Failed to find the downloaded repository"; exit 1; }
-cd local-da || { echo "Failed to find the downloaded repository"; exit 1; }Run this script to verify the repository structure:
#!/bin/bash
# Check if the local-da directory exists in the rollkit repository
git clone https://github.com/rollkit/rollkit.git temp-rollkit
if [ -d "temp-rollkit/local-da" ]; then
echo "local-da directory exists in the rollkit repository"
else
echo "local-da directory does NOT exist in the rollkit repository"
echo "Directory structure:"
find temp-rollkit -type d -maxdepth 1
fi
rm -rf temp-rollkit
There was a problem hiding this comment.
Left some comments, a lot of guides/pages are still not linked correctly. Not sure if you've run it with yarn run docs:dev yet.
Also, any reason we got rid of the Rollkit CLI that makes the binary be rollkit instead? Part of the reason we did this is to have a notion of rollkit start just like celestia light start exists for a quick-start guide.
guides/full-node.md
Outdated
| # Rollup Full Node Setup Guide | ||
|
|
||
| ## Introduction | ||
|
|
||
| This guide covers how to set up a full node to run alongside a sequencer node in a Rollkit-based blockchain network. A full node maintains a complete copy of the blockchain and helps validate transactions, improving the network's decentralization and security. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| Before starting, ensure you have: | ||
|
|
||
| - A local Data Availability (DA) network node running on port `7980`. | ||
| - A Rollkit sequencer node running and posting blocks to the DA network. | ||
| - The Rollkit CLI installed on your system. | ||
|
|
||
| ## Setting Up Your Full Node |
There was a problem hiding this comment.
Any reason we're getting rid of a full node guide?
There was a problem hiding this comment.
was going to add it back in a follow up but ill do it quickly here
There was a problem hiding this comment.
ah now i remember i removed it cause all nodes are full node, this guis is full node along side a sequencer so it doesnt make sense, Ill rework it to make sense if we want to keep it
guides/evm-single-guide.md
Outdated
| @@ -0,0 +1,162 @@ | |||
| # Rollkit EVM Single Sequencer Setup Guide | |||
There was a problem hiding this comment.
Can't access this anywhere from the sidebar
guides/gas-price.md
Outdated
| The gas price can also be configured manually with the flag | ||
| `--rollkit.da_gas_price`: | ||
| `--rollkit.da.gas_price`: | ||
|
|
||
| ```bash | ||
| rollkit start --rollkit.da_gas_price=0.1 [existing flags...] | ||
| ${BINARY_NAME} start --rollkit.da.gas_price=0.1 [existing flags...] |
There was a problem hiding this comment.
Not accessible from sidebar
There was a problem hiding this comment.
removed the file since its covered in config
| # Quick Start Guide for Artela EVM++ with Rollkit | ||
|
|
||
| <!-- markdownlint-disable MD033 --> | ||
| <script setup> | ||
| import Callout from '../../.vitepress/components/callout.vue' | ||
| import ExecutionCallout from '../../.vitepress/components/execution_callout.vue' | ||
| import constants from '../../.vitepress/constants/constants.js' | ||
| </script> |
There was a problem hiding this comment.
May be we can move this under v0.13.x since some users are still on Artela?
There was a problem hiding this comment.
hmm there are no version docs. will create a v0.13 section.
|
This single sequencer page is empty with this PR 
I also receive a 404 for http://localhost:5173/tutorials/execution/evm-contract-interaction |
There was a problem hiding this comment.
Actionable comments posted: 3
🔭 Outside diff range comments (1)
.vitepress/config.ts (1)
133-134: 🛠️ Refactor suggestionConsider implementing redirects for changed or removed pages.
With the significant navigation changes in this PR, users following older documentation links may encounter 404 errors. Consider implementing redirects from old URLs to their new locations to ensure a smooth user experience during this transition.
sidebar: { "/": sidebarHome(), + // Add redirects for changed pages + // This can be done using VitePress aliases or server-side redirects },
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
📒 Files selected for processing (1)
.vitepress/config.ts(5 hunks)
🔇 Additional comments (2)
.vitepress/config.ts (2)
220-220:✅ Verification successful
Verify that the new "Build a chain" tutorial exists and is complete.
The "Build a chain" tutorial link has been updated from "/tutorials/wordle" to "/tutorials/gm-world". Ensure this new tutorial is complete and provides equivalent or improved functionality compared to the previous tutorial.
🏁 Script executed:
#!/bin/bash # Check if the new gm-world tutorial exists and has content if [ -f "tutorials/gm-world.md" ]; then echo "New tutorial exists. Checking content..." content_size=$(wc -c < "tutorials/gm-world.md") if [ "$content_size" -lt 500 ]; then echo "WARNING: New tutorial exists but may not have sufficient content (size: $content_size bytes)" else echo "New tutorial has content (size: $content_size bytes)" fi # Check if old tutorial existed if [ -f "tutorials/wordle.md" ]; then echo "Old tutorial still exists, consider adding a redirect" else echo "Old tutorial has been removed" fi else echo "ERROR: New tutorial does not exist!" fiLength of output: 376
Verified “Build a chain” tutorial availability and completeness
- The new tutorial at
tutorials/gm-world.mdexists and contains 9 078 bytes of content, indicating a full write-up.- The old
tutorials/wordle.mdhas been removed, so there’s no stale content to redirect.All set—the link update to
/tutorials/gm-worldis correct and complete.
321-334:❓ Verification inconclusive
Verify all consolidated configuration guides are completed.
The configuration section has been significantly restructured from multiple detailed guides to a consolidated approach with additional EVM-specific guides. Ensure that all the content from the previous guides has been properly migrated to the new structure to avoid information loss.
🏁 Script executed:
#!/bin/bash # Check if all the new configuration guides exist and have content files_to_check=("guides/config.md" "guides/evm-single.md" "guides/evm-based.md" "guides/metrics.md") for file in "${files_to_check[@]}"; do if [ -f "$file" ]; then echo "$file exists. Checking content..." content_size=$(wc -c < "$file") if [ "$content_size" -lt 100 ]; then echo "WARNING: $file exists but may not have sufficient content (size: $content_size bytes)" else echo "$file has content (size: $content_size bytes)" fi else echo "ERROR: $file does not exist!" fi done # Look for old config guides that might need to be migrated echo "Looking for old configuration guides that might need content migration..." find guides -name "*.md" -type f -exec grep -l "Configuration" {} \;Length of output: 1843
Verify consolidated configuration guides content migration
The four new guides (
guides/config.md,guides/evm-single.md,guides/evm-based.md,guides/metrics.md) all exist and contain substantial content (4–22 KB each). To avoid any information loss, please manually cross-check and ensure that all relevant configuration details from the legacy guides have been fully migrated into this new structure. Legacy files referencing “Configuration” that may need review:
- guides/cometbft-to-rollkit.md
- guides/ignite-rollkit.md
- guides/use-tia-for-gas.md
- guides/overview.md
Ensure any unique sections from these are summarized or integrated in the consolidated guides.
| text: "Single", | ||
| link: "/tutorials/sequencing/single", | ||
| }, |
There was a problem hiding this comment.
💡 Verification agent
🧩 Analysis chain
Fix the empty "single sequencer" page.
According to the PR comments, the "single sequencer" page is empty, but it's being linked here in the navigation. Ensure that the content for /tutorials/sequencing/single is properly implemented before merging this PR.
🏁 Script executed:
#!/bin/bash
# Check if the single sequencer page exists and has content
if [ -f "tutorials/sequencing/single.md" ]; then
echo "File exists. Checking content..."
content_size=$(wc -c < tutorials/sequencing/single.md)
if [ "$content_size" -lt 100 ]; then
echo "WARNING: File exists but may not have sufficient content (size: $content_size bytes)"
else
echo "File has content (size: $content_size bytes)"
fi
else
echo "ERROR: File does not exist!"
fiLength of output: 323
Implement content for the “Single Sequencer” tutorial page
Our verification shows that while the navigation entry in .vitepress/config.ts correctly links to /tutorials/sequencing/single, the target file is essentially empty:
- File: tutorials/sequencing/single.md
• Exists but only ~19 bytes in size (placeholder)
Please populate single.md with the full tutorial content (overview, code examples, explanations, etc.) before merging this PR.
🤖 Prompt for AI Agents
In .vitepress/config.ts around lines 248 to 250, the navigation links to the
"single sequencer" tutorial page at /tutorials/sequencing/single, but the
corresponding markdown file tutorials/sequencing/single.md is nearly empty with
only a placeholder. To fix this, fully implement the content of single.md by
adding a comprehensive tutorial including an overview, code examples, and
explanations so that the linked page is not empty and provides value to users.
| { | ||
| text: "Run a Full Node", | ||
| link: "/guides/full-node", | ||
| }, |
There was a problem hiding this comment.
💡 Verification agent
🧩 Analysis chain
Confirm "Run a Full Node" guide is appropriately updated.
The guide appears to have been renamed from "Use the Rollkit CLI" to "Run a Full Node". Ensure that the content has been updated accordingly and provides clear instructions for users.
🏁 Script executed:
#!/bin/bash
# Check if the full-node guide exists and has been recently updated
if [ -f "guides/full-node.md" ]; then
echo "Guide exists. Checking last modification date..."
stat -c "%y" "guides/full-node.md"
echo "Checking for references to 'Rollkit CLI' that might need updating..."
grep -n "Rollkit CLI" "guides/full-node.md" || echo "No direct references to 'Rollkit CLI' found"
else
echo "ERROR: Guide does not exist!"
fiLength of output: 511
Replace remaining “Rollkit CLI” reference in the Full Node guide
There’s still one reference to “Rollkit CLI” in guides/full-node.md that needs updating to match the new “Run a Full Node” narrative:
- guides/full-node.md:13
Current:Should be revised to reflect your full-node setup instructions (e.g., “Your full-node software installed on your system”).- The Rollkit CLI installed on your system.
🤖 Prompt for AI Agents
In .vitepress/config.ts around lines 299 to 302, the link text "Run a Full Node"
is correct but the associated guide file guides/full-node.md still contains an
outdated reference to "Rollkit CLI" on line 13. Update that line in
guides/full-node.md to replace "The Rollkit CLI installed on your system." with
a phrase consistent with the new guide title, such as "Your full-node software
installed on your system," to ensure the content matches the updated narrative.
| // { | ||
| // text: "EVM", | ||
| // collapsed: true, | ||
| // items: [ | ||
| // // { text: "RETH EVM", link: "/tutorials/execution/reth-evm" }, | ||
| // ], | ||
| // }, |
There was a problem hiding this comment.
💡 Verification agent
🧩 Analysis chain
Resolve 404 error for EVM contract interaction page.
The commented-out EVM section is causing a 404 error when attempting to access the URL http://localhost:5173/tutorials/execution/evm-contract-interaction as reported in the PR comments. Either:
- Restore the EVM section with proper links, or
- Add redirects to guide users to the new content location
This is particularly important since the navigation changes might confuse users looking for EVM documentation.
🏁 Script executed:
#!/bin/bash
# Check if the EVM contract interaction page exists
if [ -f "tutorials/execution/evm-contract-interaction.md" ]; then
echo "File exists"
else
echo "File does not exist, checking for potential redirects..."
grep -r "evm-contract-interaction" --include="*.md" .
fiLength of output: 237
🏁 Script executed:
#!/bin/bash
# Verify existence and list contents of the 'tutorials' directory
echo "Checking for 'tutorials' directory at project root..."
if find . -maxdepth 2 -type d | grep -q "^./tutorials$"; then
echo "✔ 'tutorials' directory found. Contents:"
ls -1 tutorials
else
echo "✖ 'tutorials' directory not found at project root."
fi
# Verify existence and list contents of 'tutorials/execution'
echo
echo "Checking for 'tutorials/execution' directory..."
if [ -d "tutorials/execution" ]; then
echo "✔ 'tutorials/execution' directory found. Contents:"
ls -1 tutorials/execution
else
echo "✖ 'tutorials/execution' directory not found."
fiLength of output: 700
🏁 Script executed:
#!/bin/bash
# Search for any markdown files with 'evm' in their filename
echo "Looking for EVM-related markdown files..."
find . -type f -iname "*evm*.md" 2>/dev/null
echo
# Search for any directories with 'evm' in their name
echo "Looking for EVM-related directories..."
find . -type d -iname "*evm*" 2>/dev/null
echo
# Inspect references to 'evm' in the VitePress config
echo "Scanning .vitepress/config.ts for 'evm' references..."
rg -n "evm" --ignore-case .vitepress/config.ts || echo "No matches found in config.ts"Length of output: 847
Restore EVM section in sidebar and point to new guide paths
The tutorials/execution/evm-contract-interaction page no longer exists—EVM content has moved under guides. Instead of leaving the EVM block commented out, re-enable it and update its links to the new locations.
• File: .vitepress/config.ts
• Lines: ~266–272
Suggested replacement for the commented block:
{
text: "EVM",
collapsed: true,
items: [
{ text: "EVM Single Sequencer", link: "/guides/evm-single" },
{ text: "EVM Based Sequencer", link: "/guides/evm-based" },
],
},This will restore the EVM section in the sidebar and eliminate the 404 error when users navigate to EVM docs.
🤖 Prompt for AI Agents
In .vitepress/config.ts around lines 266 to 272, the EVM sidebar section is
commented out and points to outdated tutorial links causing 404 errors. To fix
this, uncomment the EVM block and update its items array to reference the new
guide paths: "/guides/evm-single" and "/guides/evm-based" with appropriate text
labels. This will restore the EVM section in the sidebar and prevent navigation
errors.
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
tutorials/da/overview.md (1)
15-15: Align section anchor with heading
The anchor{#go-da}does not match the heading “DA,” which can break intra-doc links. Please rename the anchor to{#da}(or a more descriptive identifier) to keep your links accurate.
🧹 Nitpick comments (8)
tutorials/gm-world.md (4)
33-33: Use descriptive link text
Avoid “here” as link text. For accessibility and clarity, revise to something like:You can install Ignite by following the official installation guide.
38-53: Sanitize example CLI output
Theignite versionoutput includes machine‐specific details (Your cwd,uname -a) that aren’t relevant to most readers and may expose private info. Consider truncating to only the most important fields (version, build date, SDK version).
55-55: Add an anchor ID for consistency
This heading lacks a{#generate-your-app}anchor like other sections. Adding it will ensure consistent sidebar/navigation links:- ## Generate your App + ## Generate your App {#generate-your-app}
236-254: Correct commented‐out UI section syntax
The HTML comment start (<!--) and end (::: -->) do not match, which can break parsing. Either remove this entire block or wrap it properly using:<!-- ## 📦 GM world UI app …content… -->tutorials/da/overview.md (4)
13-13: Refine core DA interface link
The hyperlink includes a hard-coded line number (#L11) which may become outdated as the interface evolves. Consider linking to the file root or to a stable documentation anchor instead.-Rollkit uses the [core da interface](https://github.com/rollkit/rollkit/blob/main/core/da/da.go#L11) to communicate to DA layers. +Rollkit uses the [core DA interface](https://github.com/rollkit/rollkit/blob/main/core/da/da.go) to communicate to DA layers.
17-17: Update reference to key interface methods
The text still highlights onlyGetandSubmitas the most important functions, but the interface now includes many more methods (e.g.,MaxBlobSize,GetIDs,Commit,Validate, etc.). Consider updating this sentence to reflect the broader set of operations supported.
22-23: Standardize GoDoc comment style
The comment “MaxBlobSize returns the max blob size” should use “maximum” instead of “max” and end with a period for consistency with GoDoc conventions.- // MaxBlobSize returns the max blob size + // MaxBlobSize returns the maximum blob size.
60-60: Fix punctuation for clarity
Add a comma to improve readability:- DA layers can integrate the `DA` interface directly into their node like [Celestia DA](celestia-da.md). + DA layers can integrate the `DA` interface directly into their node, like [Celestia DA](celestia-da.md).🧰 Tools
🪛 LanguageTool
[uncategorized] ~60-~60: Possible missing comma found.
Context: ... theDAinterface directly into their node like Celestia DA. ##...(AI_HYDRA_LEO_MISSING_COMMA)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
📒 Files selected for processing (2)
tutorials/da/overview.md(1 hunks)tutorials/gm-world.md(7 hunks)
🧰 Additional context used
🪛 GitHub Actions: Deploy PR previews
tutorials/gm-world.md
[error] 4-4: [vitepress] YAML parsing error: end of the stream or a document separator is expected at line 4, column 12 in frontmatter. This caused the build to fail.
🪛 GitHub Actions: Build VitePress Site
tutorials/gm-world.md
[error] 4-4: Vitepress build error: YAML frontmatter parsing failed - end of the stream or a document separator is expected at line 4, column 12.
🪛 LanguageTool
tutorials/da/overview.md
[uncategorized] ~60-~60: Possible missing comma found.
Context: ... the DA interface directly into their node like Celestia DA. ##...
(AI_HYDRA_LEO_MISSING_COMMA)
🔇 Additional comments (3)
tutorials/gm-world.md (1)
81-82: Verify dynamic constant interpolation
You’re using{{constants.localDALatestTag}}inside a fenced code block. Confirm that VitePress will render this value instead of displaying the raw template. If it doesn’t resolve, consider using a<CodeBlock>component or preprocessing the file.tutorials/da/overview.md (2)
19-57: DA interface expanded comprehensively
Great to see the interface definitions fleshed out with additional methods for commitment creation, proof retrieval, validation, and gas configuration. This provides clearer guidance for implementers.
60-60:✅ Verification successful
Verify Celestia DA tutorial link
Ensure thecelestia-da.mdfile exists and is correctly linked; otherwise, this will lead to a broken page.
🏁 Script executed:
#!/bin/bash # Verify that the Celestia DA tutorial exists fd celestia-da.md tutorials/daLength of output: 60
Celestia DA link verified
The filetutorials/da/celestia-da.mdexists, so the link intutorials/da/overview.md(line 60) is valid. No changes required.🧰 Tools
🪛 LanguageTool
[uncategorized] ~60-~60: Possible missing comma found.
Context: ... theDAinterface directly into their node like Celestia DA. ##...(AI_HYDRA_LEO_MISSING_COMMA)
| --- | ||
| description: Build a sovereign rollup using only Rollkit CLI and a local DA network. | ||
| --- | ||
| ++ b/tutorials/gm-world.md | ||
| @@ 1,3 | ||
| description: Build a sovereign rollup using Ignite, the `gmd` CLI, and a local DA network. | ||
|
|
There was a problem hiding this comment.
Fix YAML frontmatter formatting
The current frontmatter block is invalid—lines like ++ b/tutorials/gm-world.md and @@ 1,3 are Git diff artifacts and must be removed. Also, ensure you have a closing --- after your metadata. A minimal valid example:
---
title: "GM world rollup"
description: "Build a sovereign rollup using Ignite, the `gmd` CLI, and a local DA network."
---🧰 Tools
🪛 GitHub Actions: Deploy PR previews
[error] 4-4: [vitepress] YAML parsing error: end of the stream or a document separator is expected at line 4, column 12 in frontmatter. This caused the build to fail.
🪛 GitHub Actions: Build VitePress Site
[error] 4-4: Vitepress build error: YAML frontmatter parsing failed - end of the stream or a document separator is expected at line 4, column 12.
🤖 Prompt for AI Agents
In tutorials/gm-world.md around lines 1 to 5, remove all Git diff artifacts such
as '++ b/tutorials/gm-world.md' and '@@ 1,3' from the YAML frontmatter. Ensure
the frontmatter starts and ends with '---' lines and contains only valid YAML
key-value pairs like title and description. Add a closing '---' after the
metadata to properly close the frontmatter block.
Overview
This pr starts the redo of docs in order to comply with the v1 changes
Summary by CodeRabbit
New Features
Documentation
Removals
Chores