tutorials: clarify the difference between kurtosis devnets and op-up #1717
Conversation
✅ Deploy Preview for docs-optimism ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
📝 WalkthroughWalkthroughUpdates the tutorial at pages/operators/chain-operators/tutorials/chain-dev-net.mdx to retarget the audience to protocol developers, revise the description, and add an introduction clarifying use of Kurtosis to deploy a local OP Stack development environment that mirrors production. Replaces a prior callout with guidance for protocol developers and mentions op-up as a lightweight alternative for quickly deploying a local network. The rest of the tutorial structure and technical content remain unchanged. No changes to exported or public entities. Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Suggested reviewers
Tip 🔌 Remote MCP (Model Context Protocol) integration is now available!Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats. ✨ Finishing Touches🧪 Generate unit tests
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. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
Status, Documentation and Community
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (11)
pages/operators/chain-operators/tutorials/chain-dev-net.mdx (11)
1-18: Frontmatter looks complete; fix minor grammar in description.All required metadata fields are present and non-empty. Adjust the description to fix the missing article.
Apply this diff:
-description: This tutorial walks you through spinning up local OP Stack chain for protocol development. +description: This tutorial walks you through spinning up a local OP Stack chain for protocol development.
23-23: Use sentence case for the H1 header.Aligns with the docs style guide for headings.
-# Running a Local Development Environment +# Running a local development environment
25-27: Avoid bold for emphasis; streamline phrasing.Remove emphasis formatting and tighten wording per the style guide.
-This tutorial is **designed for protocol developers** who want to contribute to the OP Stack -by spinning up a local OP Stack development environment running with [Kurtosis](https://www.kurtosis.com/). -You'll perform the full deployment process, and **you'll end up with your very own OP Stack devnet, with smart contracts and components that closely mirror what gets run in production**. +This tutorial is designed for protocol developers who want to contribute to the OP Stack +by deploying a local OP Stack development environment with [Kurtosis](https://www.kurtosis.com/). +You will perform the full deployment process and end up with an OP Stack devnet whose contracts and components closely mirror production.
29-32: Make the callout more direct (imperative voice).Switch to imperative and tighten phrasing per style guide.
- This tutorial is intended for protocol developers. If you're looking to try out the OP Stack in a more lightweight way, - you can use the [`op-up`](https://localchain.dev) tool to deploy a local network in less than a minute. + This tutorial is intended for protocol developers. To try the OP Stack in a lightweight way, + use [`op-up`](https://localchain.dev) to deploy a local network in under a minute.
39-40: Avoid bold for emphasis in body text.Remove bold to comply with the docs style guide.
-**The OP Stack is free and open source software licensed entirely under the MIT license**. You don't need permission from +The OP Stack is free and open source software licensed entirely under the MIT license. You don't need permission from
47-47: Use sentence case for the H2 header.-## Installing Dependencies +## Installing dependencies
54-60: Heading case and platform naming; prefer imperative voice.
- Use sentence case in the H3.
- Replace “OSX” with “macOS.”
- Prefer imperative voice over “We recommend.”
-### Notes on Specific Dependencies +### Notes on specific dependencies @@ -We recommend using the latest version of Docker on Linux, or [OrbStack](https://orbstack.dev/) (a drop-in replacement -for Docker Desktop) on OSX. +Use the latest version of Docker on Linux, or [OrbStack](https://orbstack.dev/) (a drop-in replacement +for Docker Desktop) on macOS.
21-21: Remove unused import.WipCallout is imported but not used anywhere in the page.
-import {WipCallout} from '@/components/WipCallout'
168-171: Fix capitalization and wording (“rollup,” “RPC URL,” and “output”).
- Use “rollup” (lowercase) unless nouns.txt specifies otherwise.
- Capitalize “RPC URL.”
- Prefer “output” over “outputted.”
- Prefer imperative voice.
Please confirm “rollup” capitalization against nouns.txt.
-You now have a fully functioning OP Stack Rollup. You can connect your wallet to this chain the same way you'd connect +You now have a fully functioning OP Stack rollup. Connect your wallet to this chain the same way you'd connect @@ -Your enclave name is outputted at the end of the `kurtosis run` command above. The RPC url is the `rpc` port name in any +Your enclave name is output at the end of the `kurtosis run` command above. The RPC URL is the `rpc` port name in any
215-215: Use sentence case for the H2 header.-## See Your Rollup in Action +## See your rollup in action
220-220: Use sentence case for the H2 header.-## Next Steps +## Next steps
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
pages/operators/chain-operators/tutorials/chain-dev-net.mdx(2 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
**/*.mdx
⚙️ CodeRabbit Configuration File
**/*.mdx: "ALWAYS review Markdown content THOROUGHLY with the following criteria:
- First, check the frontmatter section at the top of the file:
- For regular pages, ensure ALL these fields are present and not empty:
--- title: [non-empty] lang: [non-empty] description: [non-empty] topic: [non-empty] personas: [non-empty array] categories: [non-empty array] content_type: [valid type] ---
- For landing pages (index.mdx or files with ), only these fields are required:
--- title: [non-empty] lang: [non-empty] description: [non-empty] topic: [non-empty] ---
- If any required fields are missing or empty, comment:
'This file appears to be missing required metadata. Please check keywords.config.yaml for valid options and add the required fields manually. You can validate your changes by running:pnpm validate-metadata ```'- Use proper nouns in place of personal pronouns like 'We' and 'Our' to maintain consistency in communal documentation.
- Avoid gender-specific language and use the imperative form.
- Monitor capitalization for emphasis. Avoid using all caps, italics, or bold for emphasis.
- Ensure proper nouns are capitalized in sentences.
- Apply the Oxford comma.
- Use proper title case for buttons, tab names, page names, and links. Sentence case should be used for body content and short phrases, even in links.
- Use correct spelling and grammar at all times (IMPORTANT).
- For H1, H2, and H3 headers:
- Use sentence case, capitalizing only the first word.
- Preserve the capitalization of proper nouns, technical terms, and acronyms as defined in the 'nouns.txt' file located in the root directory of the project.
- Do not automatically lowercase words that appear in the 'nouns.txt' file, regardless of their position in the header.
- Flag any headers that seem to inconsistently apply these rules for manual review.
- When rev...
Files:
pages/operators/chain-operators/tutorials/chain-dev-net.mdx
🧠 Learnings (2)
📓 Common learnings
Learnt from: sbvegan
PR: ethereum-optimism/docs#1001
File: pages/builders.mdx:11-12
Timestamp: 2024-10-22T02:58:02.175Z
Learning: Prefer using 'OP Stack' over 'OP Mainnet' in documentation for consistency.
📚 Learning: 2024-10-22T02:58:02.175Z
Learnt from: sbvegan
PR: ethereum-optimism/docs#1001
File: pages/builders.mdx:11-12
Timestamp: 2024-10-22T02:58:02.175Z
Learning: Prefer using 'OP Stack' over 'OP Mainnet' in documentation for consistency.
Applied to files:
pages/operators/chain-operators/tutorials/chain-dev-net.mdx
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: Redirect rules - docs-optimism
- GitHub Check: Header rules - docs-optimism
- GitHub Check: Pages changed - docs-optimism
🔇 Additional comments (1)
pages/operators/chain-operators/tutorials/chain-dev-net.mdx (1)
30-31: Confirmed: use "op-up" (run viacargo run) — no change required
- Reason: the op-up repo README shows the quick workflow (git clone https://github.com/op-rs/op-up && cargo run; stop:
cargo run -- stop; reset:cargo run -- nuke).- File to note: pages/operators/chain-operators/tutorials/chain-dev-net.mdx (lines 30–31) — the current link text
op-up→ https://localchain.dev is correct. Optionally, link directly to the repo or add a brief CLI hint ("run withcargo run") for clarity.
We will soon start pushing people who are just "trying out" the OP Stack to use localchain.dev instead of running Kurtosis, which is more of a full-fledged development environment. This PR updates the Kurtosis tutorial to clarity that.