Skip to content

feat: testnet deployment #596

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.

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 2 commits into
base: main
Choose a base branch
from
Open

feat: testnet deployment #596

wants to merge 2 commits into from

Conversation

auricom
Copy link
Contributor

@auricom auricom commented Jul 16, 2025

  • Reorganizing the Rollkit deployment pages
  • Testnet deployment guide

Summary by CodeRabbit

  • New Features
    • Added a new overview page and a detailed testnet deployment guide for Rollkit-based EVM chains, including architecture diagrams and explanations.
  • Documentation
    • Updated sidebar navigation to split the deployment section into "Local (dev)" and "Testnet" guides, and adjusted overview link paths.
    • Renamed and updated the local deployment guide for clarity and improved formatting.
    • Updated deployment overview links to reflect new guide locations.

Copy link
Contributor

coderabbitai bot commented Jul 16, 2025

Walkthrough

The documentation structure for deploying Rollkit chains was reorganized. The sidebar navigation was updated, splitting the "Docker Compose" guide into separate "Local (dev)" and "Testnet" guides. New overview and testnet deployment markdown files were added, and the local deployment guide received minor formatting and import path corrections.

Changes

File(s) Change Summary
.vitepress/config.ts Updated sidebar: changed overview link, split "Docker Compose" into "Local (dev)" and "Testnet" entries.
guides/deploy/local.md Renamed title, updated component import paths, minor formatting fixes in Dockerfile snippets.
guides/deploy/overview.md Added new overview documentation for Rollkit deployment methods and considerations.
guides/deploy/testnet.md Added comprehensive testnet deployment guide for Rollkit EVM chains, architecture, and Docker Compose.
guides/deploy-overview.md Updated deployment overview link from Docker Compose to local deployment guide.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant DocsSidebar
    participant Guides

    User->>DocsSidebar: Select "Deploy your chain"
    DocsSidebar->>User: Show "Overview", "Local (dev)", "Testnet"
    User->>Guides: Clicks "Overview"
    Guides->>User: Displays overview content
    User->>Guides: Clicks "Local (dev)" or "Testnet"
    Guides->>User: Displays respective deployment guide
Loading

Possibly related PRs

Suggested reviewers

  • tuxcanfly
  • Manav-Aggarwal
  • gupadhyaya

Poem

Hopping through docs, I split and I sort,
Local and testnet, each gets a report.
Overview’s new, and the sidebar’s just right—
Now guides are as clear as a moonlit night.
With Docker and Rollkit, deployment’s a breeze,
This bunny loves tidy docs—carrots, please! 🥕

✨ Finishing Touches
  • 📝 Generate Docstrings

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.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need 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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Summary of Changes

Hello @auricom, 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 significantly enhances our documentation by introducing a detailed guide for deploying Rollkit EVM chains on a testnet. To support this, I've also reorganized the existing deployment content into a more logical structure, making it easier for users to navigate and understand different deployment scenarios.

Highlights

  • New Testnet Deployment Guide: I've added a comprehensive new guide (guides/deploy/testnet.md) detailing the architecture, components (RETH, Rollkit, Celestia DA), and configurations required for deploying a Rollkit EVM testnet. This includes a Mermaid diagram illustrating the system's interactions.
  • Documentation Reorganization: The existing deployment-related documentation has been reorganized into a new guides/deploy/ directory. This includes renaming the docker-compose.md guide to local.md and moving it under this new structure.
  • New Deployment Overview Page: A new overview page (guides/deploy/overview.md) has been introduced to provide a high-level introduction to different rollup deployment scales (local and testnet) and to serve as a central entry point for the deployment guides.
  • Sidebar Navigation Updates: The .vitepress/config.ts file has been updated to reflect the new documentation structure, ensuring the sidebar navigation correctly links to the new overview, local (formerly Docker Compose), and testnet deployment guides.
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

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

Copy link
Contributor

github-actions bot commented Jul 16, 2025

PR Preview Action v1.6.2

🚀 View preview at
https://rollkit.github.io/docs-preview/pr-596/

Built to branch main at 2025-07-17 16:04 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request reorganizes the deployment documentation into a new guides/deploy section and adds a new comprehensive guide for testnet deployments. The changes are well-structured and improve the documentation's clarity. I've found a few broken links in the new testnet guide that should be fixed. Otherwise, the changes look good.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between dda588f and e72f2d9.

📒 Files selected for processing (4)
  • .vitepress/config.ts (1 hunks)
  • guides/deploy/local.md (3 hunks)
  • guides/deploy/overview.md (1 hunks)
  • guides/deploy/testnet.md (1 hunks)
🧰 Additional context used
🧠 Learnings (1)
.vitepress/config.ts (4)
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).
🪛 LanguageTool
guides/deploy/testnet.md

[style] ~3-~3: Try using a synonym here to elevate your writing.
Context: ...rchitecture choices and components that make up a complete EVM-based chain deployment. ...

(CONSTITUTE_COMPRISE)

🔇 Additional comments (9)
guides/deploy/local.md (3)

1-1: Good documentation restructuring!

The title change from "🐳 Docker Compose" to "🏠 Local" better reflects the purpose of this guide for local development environments and aligns well with the new documentation structure.


9-10: Import path updates are correct.

The relative import paths have been properly updated to account for the new file location in the guides/deploy/ directory structure.


64-84: Minor whitespace cleanup improves readability.

The removal of trailing spaces in the Dockerfile RUN commands enhances code cleanliness without affecting functionality.

.vitepress/config.ts (1)

260-269: Excellent documentation structure improvement!

The sidebar reorganization effectively separates deployment concerns:

  • Overview provides a landing page for deployment concepts
  • "Local (dev)" clearly indicates development-focused deployment
  • "Testnet" addresses production-like deployment scenarios

This structure makes it much easier for users to find the appropriate deployment guide for their needs.

guides/deploy/overview.md (1)

1-48: Excellent overview page for deployment guidance!

This new overview page effectively:

  • Explains the trade-offs between flexibility and complexity in Rollkit deployments
  • Clearly distinguishes between local development and testnet deployment scenarios
  • Provides appropriate context for users to choose the right deployment approach
  • Includes necessary disclaimers about production considerations

The structure and content provide valuable guidance for users navigating deployment options.

guides/deploy/testnet.md (4)

22-82: Excellent architecture diagram and explanation!

The Mermaid diagram effectively illustrates the complex interactions between:

  • RETH and ROLLKIT services in each node stack
  • P2P networking between nodes
  • Data availability layer integration
  • User access patterns

This visual representation significantly enhances understanding of the deployment architecture.


184-199: Clear timing configuration explanation.

The explanation of block time parameters is well-structured and informative:

  • Distinguishes between sequencer block time and DA block time
  • Provides default values and customization guidance
  • Explains the practical implications of each parameter

This helps users understand the timing trade-offs in their deployments.


200-245: Comprehensive Celestia integration coverage.

The detailed explanation of Celestia-App and Celestia-Node services, along with their specific roles in sequencer vs full node communication, provides essential context for understanding the DA layer integration.


275-277: Appropriate production deployment warning.

The disclaimer about testnet vs production deployment is well-placed and important for setting proper expectations about the deployment approach's limitations.

@auricom auricom marked this pull request as draft July 16, 2025 16:58
@auricom auricom force-pushed the claude/testnet_deployment branch 2 times, most recently from 8ad0fb5 to 3d14f73 Compare July 17, 2025 08:02
tac0turtle
tac0turtle previously approved these changes Jul 17, 2025
@auricom auricom marked this pull request as ready for review July 17, 2025 15:30
@auricom auricom force-pushed the claude/testnet_deployment branch from 3d14f73 to 0db8a94 Compare July 17, 2025 15:32
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (2)
guides/deploy/overview.md (1)

38-40: Use a single bullet style throughout the doc

Lines 38-40 use * while the rest of the page uses -, tripping MD004 and breaking visual consistency.

-* [🏠 Local Development with Docker Compose](./local.md) - Deploy locally for development and testing
-* [🌐 Testnet Deployment](./testnet.md) - Deploy on testnet with external DA networks
+ - [🏠 Local Development with Docker Compose](./local.md) - Deploy locally for development and testing
+ - [🌐 Testnet Deployment](./testnet.md) - Deploy on testnet with external DA networks
guides/deploy/testnet.md (1)

234-236: Drop the tautology “API interface”

“API” already includes “interface”. Removing the extra word tightens the prose.

-3. **API Endpoints**: Both sequencer and full nodes use the same celestia-node API interface
+3. **API Endpoints**: Both sequencer and full nodes use the same celestia-node API
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e72f2d9 and 3d14f73.

📒 Files selected for processing (5)
  • .vitepress/config.ts (1 hunks)
  • guides/deploy-overview.md (1 hunks)
  • guides/deploy/local.md (3 hunks)
  • guides/deploy/overview.md (1 hunks)
  • guides/deploy/testnet.md (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • guides/deploy-overview.md
🚧 Files skipped from review as they are similar to previous changes (2)
  • .vitepress/config.ts
  • guides/deploy/local.md
🧰 Additional context used
🧠 Learnings (1)
guides/deploy/testnet.md (6)
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-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: 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.
🪛 markdownlint-cli2 (0.17.2)
guides/deploy/overview.md

38-38: Unordered list style
Expected: dash; Actual: asterisk

(MD004, ul-style)


39-39: Unordered list style
Expected: dash; Actual: asterisk

(MD004, ul-style)

🪛 LanguageTool
guides/deploy/testnet.md

[style] ~3-~3: Try using a synonym here to elevate your writing.
Context: ...rchitecture choices and components that make up a complete EVM-based chain deployment. ...

(CONSTITUTE_COMPRISE)


[style] ~236-~236: This phrase is redundant (‘I’ stands for ‘interface’). Use simply “API”.
Context: ...d full nodes use the same celestia-node API interface 4. Network Configuration: All nodes...

(ACRONYM_TAUTOLOGY)

🪛 GitHub Actions: Link Checker
guides/deploy/testnet.md

[error] 1-1: Network error 404: https://github.com/rollkit/ops-toolbox/tree/main/ev-stacks not found.


[error] 1-1: Network error 404: https://github.com/rollkit/ops-toolbox/tree/main/ev-stacks/ not found.

🔇 Additional comments (1)
guides/deploy/testnet.md (1)

266-267: External link returns 404 – verify path in ops-toolbox

The GitHub Actions link-checker reports https://github.com/rollkit/ops-toolbox/tree/main/ev-stacks (with/without trailing slash) as 404.
Confirm the correct directory (e.g. evm-stacks?) and update the link.

-[https://github.com/rollkit/ops-toolbox/tree/main/ev-stacks](https://github.com/rollkit/ops-toolbox/tree/main/ev-stacks/)
+[https://github.com/rollkit/ops-toolbox/tree/main/evm-stacks](https://github.com/rollkit/ops-toolbox/tree/main/evm-stacks)

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (4)
guides/deploy/overview.md (2)

38-39: Replace * bullets with - to satisfy markdownlint (MD004).

The repo’s docs mostly use dash-style bullets and the linter flags the current asterisk style.

-* [🏠 Local Development with Docker Compose](./local.md) - Deploy locally for development and testing
-* [🌐 Testnet Deployment](./testnet.md) - Deploy on testnet with external DA networks
+- [🏠 Local Development with Docker Compose](./local.md) - Deploy locally for development and testing
+- [🌐 Testnet Deployment](./testnet.md) - Deploy on testnet with external DA networks

1-3: Add a title field to the front-matter for better SEO / sidebar labels.

 ---
 description: This page provides an overview of some common ways to deploy rollups.
+title: Deploying Your Rollup
 ---
guides/deploy/testnet.md (2)

8-11: Prefer VitePress alias imports to fragile relative paths.

Using @/ keeps the path stable if this document is ever moved.

-import Callout from '../../.vitepress/components/callout.vue'
-import constants from '../../.vitepress/constants/constants.js'
+import Callout from '@/components/callout.vue'
+import constants from '@/constants/constants.js'

96-108: Fix heading hierarchy – make “Single Sequencer” a sub-heading.

### 🔄 Single Sequencer is a sibling of “Choosing Your Sequencing Topology” instead of a child.
Downgrading it to #### keeps the TOC logical.

-### 🔄 Single Sequencer
+#### 🔄 Single Sequencer
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3d14f73 and 0db8a94.

📒 Files selected for processing (5)
  • .vitepress/config.ts (1 hunks)
  • guides/deploy-overview.md (1 hunks)
  • guides/deploy/local.md (3 hunks)
  • guides/deploy/overview.md (1 hunks)
  • guides/deploy/testnet.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (3)
  • guides/deploy-overview.md
  • guides/deploy/local.md
  • .vitepress/config.ts
🧰 Additional context used
🧠 Learnings (1)
guides/deploy/testnet.md (6)
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-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: 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.
🪛 markdownlint-cli2 (0.17.2)
guides/deploy/overview.md

38-38: Unordered list style
Expected: dash; Actual: asterisk

(MD004, ul-style)


39-39: Unordered list style
Expected: dash; Actual: asterisk

(MD004, ul-style)

🪛 LanguageTool
guides/deploy/testnet.md

[style] ~3-~3: Try using a synonym here to elevate your writing.
Context: ...rchitecture choices and components that make up a complete EVM-based chain deployment. ...

(CONSTITUTE_COMPRISE)

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (3)
guides/deploy/overview.md (3)

1-4: Add a title entry to the front-matter for navigation & SEO consistency

Most pages in the docs include a title: field in the YAML block so that VitePress can pick it up for side-bars, page <title>, and search.
Add it alongside description to keep metadata uniform.

 ---
+title: Deploying Your Rollup
 description: This page provides an overview of some common ways to deploy rollups.
 ---

38-40: Use dashes instead of asterisks to match the project’s list style (MD004)

markdownlint flags the asterisk list markers here.
Everywhere else in the docs we use - — switching keeps the style consistent and silences the linter.

-* [🏠 Local Development with Docker Compose](./local.md) - Deploy locally for development and testing
-* [🌐 Testnet Deployment](./testnet.md) - Deploy on testnet with external DA networks
+- [🏠 Local Development with Docker Compose](./local.md) - Deploy locally for development and testing
+- [🌐 Testnet Deployment](./testnet.md) - Deploy on testnet with external DA networks

41-43: Optional: shorten the admonition title

:::warning Disclaimer renders the title as Disclaimer anyway, so the extra word is redundant.
Consider dropping it for brevity:

-:::warning Disclaimer
+:::warning
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0db8a94 and c22795e.

📒 Files selected for processing (1)
  • guides/deploy/overview.md (1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
guides/deploy/overview.md

38-38: Unordered list style
Expected: dash; Actual: asterisk

(MD004, ul-style)


39-39: Unordered list style
Expected: dash; Actual: asterisk

(MD004, ul-style)

@auricom auricom force-pushed the claude/testnet_deployment branch from c22795e to 58a0a39 Compare July 17, 2025 16:04
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (2)
guides/deploy/overview.md (1)

38-39: Use the project-wide dash list style to satisfy markdownlint

The linter flags these two list items because they start with * instead of the repository-standard -.
Switching to dashes keeps the docs consistent and eliminates the MD004 warning.

-* [🏠 Local Development with Docker Compose](./local.md) - Deploy locally for development and testing
-* [🌐 Testnet Deployment](./testnet.md) - Deploy on testnet with external DA networks
+- [🏠 Local Development with Docker Compose](./local.md) - Deploy locally for development and testing
+- [🌐 Testnet Deployment](./testnet.md) - Deploy on testnet with external DA networks
guides/deploy/testnet.md (1)

236-236: Remove the “interface” tautology

“API” already includes the word interface.
Trim the repetition for cleaner wording and silence LanguageTool.

-3. **API Endpoints**: Both sequencer and full nodes use the same celestia-node API interface
+3. **API Endpoints**: Both sequencer and full nodes use the same celestia-node API
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c22795e and 58a0a39.

📒 Files selected for processing (5)
  • .vitepress/config.ts (1 hunks)
  • guides/deploy-overview.md (1 hunks)
  • guides/deploy/local.md (3 hunks)
  • guides/deploy/overview.md (1 hunks)
  • guides/deploy/testnet.md (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • guides/deploy-overview.md
🚧 Files skipped from review as they are similar to previous changes (2)
  • .vitepress/config.ts
  • guides/deploy/local.md
🧰 Additional context used
🧠 Learnings (1)
guides/deploy/testnet.md (6)
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-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: 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.
🪛 LanguageTool
guides/deploy/testnet.md

[style] ~3-~3: Try using a synonym here to elevate your writing.
Context: ...rchitecture choices and components that make up a complete EVM-based chain deployment. ...

(CONSTITUTE_COMPRISE)


[style] ~236-~236: This phrase is redundant (‘I’ stands for ‘interface’). Use simply “API”.
Context: ...d full nodes use the same celestia-node API interface 4. Network Configuration: All nodes...

(ACRONYM_TAUTOLOGY)

🪛 markdownlint-cli2 (0.17.2)
guides/deploy/overview.md

38-38: Unordered list style
Expected: dash; Actual: asterisk

(MD004, ul-style)


39-39: Unordered list style
Expected: dash; Actual: asterisk

(MD004, ul-style)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants