Skip to content

chore: update docs for v1 (1/n) #564

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 15 commits into
base: main
Choose a base branch
from
Open

chore: update docs for v1 (1/n) #564

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
84e6767
update docs
tac0turtle May 5, 2025
9e8b27f
amend toc
tac0turtle May 5, 2025
df72553
clean up docs
tac0turtle May 12, 2025
d90c9bc
add docs on config
tac0turtle May 13, 2025
58dda90
add link to metrci docs
tac0turtle May 13, 2025
087f382
updats to docs
tac0turtle May 13, 2025
42474f1
some linting
tac0turtle May 13, 2025
0edcfda
short description of sequencing
tac0turtle May 13, 2025
76678c5
remove wordle
tac0turtle May 13, 2025
2e52c2c
update gm app
tac0turtle May 13, 2025
d9126dd
fix config
tac0turtle May 13, 2025
12e7aeb
remove line from config
tac0turtle May 13, 2025
a9abd94
add things to config and reintroduce full node guide
tac0turtle May 14, 2025
c8a81f8
remove evm
tac0turtle May 19, 2025
a9d7e1f
minor updates
tac0turtle May 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
106 changes: 27 additions & 79 deletions .vitepress/config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,6 @@ function nav() {
{ text: "Learn", link: "/learn/intro" },
{ text: "Tutorials", link: "/tutorials/quick-start" },
{ text: "How To Guides", link: "/guides/overview" },
// { text: "Testnets", link: "/testnets/cosmwasm-testnet" },
{ text: "Blog", link: "/blog/overview" },
];
}
Expand Down Expand Up @@ -218,7 +217,7 @@ function sidebarHome() {
text: "Quick start guide",
link: "/tutorials/quick-start",
},
{ text: "Build a chain", link: "/tutorials/wordle" },
{ text: "Build a chain", link: "/tutorials/gm-world" },
{
text: "DA",
collapsed: true,
Expand All @@ -235,10 +234,6 @@ function sidebarHome() {
text: "Celestia",
link: "/tutorials/da/celestia-da",
},
{
text: "Avail",
link: "/tutorials/da/avail-da",
},
],
},
{
Expand All @@ -250,12 +245,8 @@ function sidebarHome() {
link: "/tutorials/sequencing/overview",
},
{
text: "Local",
link: "/tutorials/sequencing/local",
},
{
text: "Centralized",
link: "/tutorials/sequencing/centralized",
text: "Single",
link: "/tutorials/sequencing/single",
},
Comment on lines +248 to 250
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 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!"
fi

Length 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: "Based",
Expand All @@ -265,32 +256,20 @@ function sidebarHome() {
text: "Forced Inclusion",
link: "/tutorials/sequencing/forced-inclusion",
},
{
text: "Astria",
link: "/tutorials/sequencing/astria",
},
],
},
{
text: "Execution",
collapsed: true,
items: [
{ text: "CosmWasm", link: "/tutorials/execution/cosmwasm" },
{
text: "EVM",
collapsed: true,
items: [
{ text: "BeaconKit EVM", link: "/tutorials/execution/beaconkit" },
{
text: "Artela EVM++",
link: "/tutorials/execution/artela-evm-plus-plus",
},
{
text: "Contract interaction",
link: "/tutorials/execution/evm-contract-interaction",
},
],
},
// {
// text: "EVM",
// collapsed: true,
// items: [
// // { text: "RETH EVM", link: "/tutorials/execution/reth-evm" },
// ],
// },
Comment on lines +266 to +272
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 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:

  1. Restore the EVM section with proper links, or
  2. 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" .
fi

Length 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."
fi

Length 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.

],
},
{
Expand All @@ -305,10 +284,6 @@ function sidebarHome() {
text: "Docker Compose",
link: "/tutorials/docker-compose",
},
// {
// text: "Kurtosis",
// link: "/tutorials/kurtosis",
// },
],
},
],
Expand All @@ -317,14 +292,14 @@ function sidebarHome() {
text: "How To Guides",
collapsed: true,
items: [
{
text: "Use the Rollkit CLI",
link: "/guides/use-rollkit-cli",
},
{
text: "Use Ignite to create a Rollkit app",
link: "/guides/ignite-rollkit",
},
{
text: "Run a Full Node",
link: "/guides/full-node",
},
Comment on lines +299 to +302
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 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!"
fi

Length 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: 
    - The Rollkit CLI installed on your system.
    Should be revised to reflect your full-node setup instructions (e.g., “Your full-node software 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: "Restart your rollup",
link: "/guides/restart-rollup",
Expand All @@ -333,10 +308,6 @@ function sidebarHome() {
text: "Reset your chain's state",
link: "/guides/reset-state",
},
{
text: "Run a rollup full node",
link: "/guides/full-node",
},
{
text: "CometBFT into a Rollkit app",
link: "/guides/cometbft-to-rollkit",
Expand All @@ -347,33 +318,19 @@ function sidebarHome() {
},
{
text: "Configuration",
collapsed: true,
items: [
{
text: "Configure gas price",
link: "/guides/gas-price",
},
{
text: "Configure max pending blocks",
link: "/guides/max-pending-blocks",
},
{
text: "Configure DA chain block sync time",
link: "/guides/da-block-time",
},
{
text: "Change speed of block production",
link: "/guides/block-times",
},
{
text: "Use lazy sequencing (aggregation)",
link: "/guides/lazy-sequencing",
},
{
text: "Configure Prometheus metrics",
link: "/guides/metrics",
},
],
link: "/guides/config",
},
{
text: "EVM Single Sequencer",
link: "/guides/evm-single",
},
{
text: "EVM Based Sequencer",
link: "/guides/evm-based",
},
{
text: "Metrics",
link: "/guides/metrics",
},
{
text: "Integrations",
Expand All @@ -388,10 +345,6 @@ function sidebarHome() {
text: "Add an IBC connection to your rollup",
link: "/guides/ibc-connection",
},
{
text: "Integrate Range with your rollup",
link: "/guides/rollkit-monitoring",
},
{
text: "Use IBC token (TIA) as gas token in your rollup",
link: "/guides/use-tia-for-gas",
Expand All @@ -400,11 +353,6 @@ function sidebarHome() {
},
],
},
// {
// text: "Testnets",
// collapsed: true,
// items: [{ text: "CosmWasm Testnet", link: "/testnets/cosmwasm-testnet" }],
// },
{
text: "Blog",
collapsed: true,
Expand Down
37 changes: 0 additions & 37 deletions guides/block-times.md
View file
Open in desktop

This file was deleted.

Loading
Loading