Update chain-dev-net.mdx #1714
Update chain-dev-net.mdx #1714
Conversation
✅ Deploy Preview for docs-optimism ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Pull Request Overview
This PR updates the Optimism devnet configuration tutorial to reflect changes in the optimism-package structure. The update addresses outdated documentation that was preventing new users from successfully launching a devnet.
- Updates YAML configuration format from a list-based to a map-based structure
- Adds more detailed node configuration with explicit EL and CL layer specifications
- Includes reference link to the upstream repository for additional details
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
|
Note Other AI code review bot(s) detectedCodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review. 📝 WalkthroughWalkthroughReplaces the optimism_package.chains YAML example in pages/operators/chain-operators/tutorials/chain-dev-net.mdx from a list-based, inline-participants schema to a map keyed by chain name. The new example defines a single chain (rollup-1) with explicit node entries (node0, node1) and per-node nested el and cl configuration including explicit type fields. The previous network_params block (name, network_id) is removed and the chain key is used as the identifier. Added comments document the hierarchical mapping and node/EL/CL flags. Estimated code review effort🎯 2 (Simple) | ⏱️ ~7 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. 📜 Recent review detailsConfiguration used: .coderabbit.yaml 💡 Knowledge Base configuration:
You can enable these sources in your CodeRabbit configuration. 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
⏰ 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). (4)
✨ 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: 1
🔭 Outside diff range comments (1)
pages/operators/chain-operators/tutorials/chain-dev-net.mdx (1)
23-23: Align headers with sentence case per style guide.Update H1–H3 headers to sentence case while preserving proper nouns.
-# Running a Local Development Environment +# Running a local development environment-## Installing Dependencies +## Installing dependencies-### Notes on Specific Dependencies +### Notes on specific dependencies-## See Your Rollup in Action +## See your rollup in action-## Next Steps +## Next stepsAlso applies to: 46-46, 53-53, 228-228, 233-233
🧹 Nitpick comments (8)
pages/operators/chain-operators/tutorials/chain-dev-net.mdx (8)
27-27: Fix proper noun capitalization: GitHub.- [Github](https://github.com/ethereum-optimism/optimism). + [GitHub](https://github.com/ethereum-optimism/optimism).
57-58: Use imperative voice and correct platform name (macOS).Replace first person plural and “OSX.”
-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.
72-72: Minor grammar: pluralize “detail.”-# Check https://github.com/ethpandaops/optimism-package for more detail. +# Check https://github.com/ethpandaops/optimism-package for more details.
80-80: Remove unnecessary hyphenation in “optimism-participants.”- # Specification of the optimism-participants in the network. + # Specification of the participants in the network.
84-88: Normalize EL/CL comments: spacing and sentence case.- # EL(Execution Layer) Specific flags. + # EL (execution layer) specific flags. el: type: op-geth - # CL(Consensus Layer) Specific flags + # CL (consensus layer) specific flags. cl: type: op-node
96-96: Avoid first person plural; prefer imperative/neutral voice.-Save the above configuration to a file. For the rest of this tutorial, we'll assume you've saved it to `network-config.yaml`. +Save the above configuration to a file. For the rest of this tutorial, assume that it is saved to `network-config.yaml`.
183-183: Capitalize acronym: URL.-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
235-237: Eliminate repetition and tighten “Next steps” bullets.Two consecutive bullets start with “If you run into any problems.” Reword for clarity and to avoid duplication.
-* If you run into any problems, please visit the [chain operators troubleshooting guide](/operators/chain-operators/management/troubleshooting) -* If you run into any problems, please [file an issue](https://github.com/ethereum-optimism/optimism/issues) or join the [Superchain Dev Discord](https://guild.xyz/superchain-devs) for help. +* Visit the [chain operators troubleshooting guide](/operators/chain-operators/management/troubleshooting). +* Get help by [filing an issue](https://github.com/ethereum-optimism/optimism/issues) or joining the [Superchain Dev Discord](https://guild.xyz/superchain-devs).
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
pages/operators/chain-operators/tutorials/chain-dev-net.mdx(1 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
⏰ 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)
1-18: Frontmatter metadata is complete and valid.All required fields are present and non-empty (title, lang, description, topic, personas, categories, content_type). No action needed.
Co-authored-by: Copilot <[email protected]>
2 participants
The doc is outdated.
As a new user of the Optimism platform, I found that I can’t launch the devnet following the tutorial.
So, I checked the latest Optimism package changes.