Fixed typoes in dev-node.mdx

[gologo13]

Description

Fixed typos and invalid network-config.yaml in Running a Local Development Environment.

Tests

I can confirm that the fixed network-config.yaml gave me the successful kurtosis result.

Additional context

I followed this guide and tried setting up a local optimism node, but encountered the following error.
https://docs.optimism.io/chain/testing/dev-node

$ kurtosis run github.com/ethpandaops/ethereum-package --args-file ./network-config.yaml
INFO[2024-11-26T16:58:45-08:00] Creating a new enclave for Starlark to run inside...
INFO[2024-11-26T16:58:47-08:00] Enclave 'muddy-canyon' created successfully
There was an error interpreting Starlark code 
Evaluation error: fail: Invalid parameter optimism_package, allowed fields ["participants", "participants_matrix", "network_params", "dora_params", "tx_spammer_params", "goomy_blob_params", "prometheus_params", "grafana_params", "assertoor_params", "mev_params", "xatu_sentry_params", "port_publisher", "wait_for_finalization", "global_log_level", "snooper_enabled", "ethereum_metrics_exporter_enabled", "parallel_keystore_generation", "disable_peer_scoring", "persistent", "mev_type", "xatu_sentry_enabled", "apache_port", "global_tolerations", "global_node_selectors", "keymanager_enabled", "checkpoint_sync_enabled", "checkpoint_sync_url", "additional_services"]
        at [github.com/ethpandaops/ethereum-package/main.star:83:57]: run
        at [github.com/ethpandaops/ethereum-package/src/package_io/input_parser.star:89:30]: input_parser
        at [github.com/ethpandaops/ethereum-package/src/package_io/sanity_check.star:359:17]: sanity_check
        at [0:0]: fail

Error encountered running Starlark code.

Metadata

none

[netlify]

✅ Deploy Preview for docs-optimism ready!

Name	Link
🔨 Latest commit	09551ba
🔍 Latest deploy log	https://app.netlify.com/sites/docs-optimism/deploys/674672134bab880008774008
😎 Deploy Preview	https://deploy-preview-1146--docs-optimism.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[coderabbitai]

📝 Walkthrough

Walkthrough

The changes in this pull request primarily involve updates to the documentation for setting up a local development environment for the OP Stack. The key modifications include renaming the chain_id parameter to network_id in the YAML configuration example, reflecting a change in terminology. Additionally, the command for starting the network has been revised to utilize optimism-package instead of ethereum-package, indicating a shift in the package being referenced. The documentation also emphasizes the importance of using a specific YAML file for network configuration, highlighting the need for precise naming conventions. These updates aim to provide clearer instructions and ensure users are directed to the correct resources and commands for deploying their development environment.

Possibly related PRs

• update devnet #834: This PR updates the dev-node.mdx file, which is directly related to the changes made in the main PR regarding the documentation for setting up a local development environment.
• Add tutorial for devnet #914: This PR also modifies the dev-node.mdx file, focusing on setting up an OP Stack devnet chain, which aligns with the main PR's changes to local development environment documentation.
• Op deployer updates #1020: This PR updates the op-deployer documentation, which is relevant as it may involve similar configuration aspects mentioned in the main PR regarding network setup.
• Documentation Improvements: Grammar, Structure, and Readability Fixes #1057: This PR includes various grammatical and structural improvements across documentation, which may enhance the clarity of the changes made in the main PR.
• Documentation Text Fixes Changes Made #1128: This PR addresses grammatical corrections in multiple documentation files, including those related to the setup and configuration processes relevant to the main PR.
• Fix typos and remove duplicate entries Changes Made #1136: This PR fixes typographical errors in documentation templates, which could indirectly relate to the clarity and professionalism of the documentation changes in the main PR.

Suggested labels

documentation

Suggested reviewers

• cpengilly
• bradleycamacho

---

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 50f2445 and 09551ba.

📒 Files selected for processing (1)

• pages/chain/testing/dev-node.mdx (2 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

pages/chain/testing/dev-node.mdx (1)

Pattern **/*.mdx: "ALWAYS review Markdown content THOROUGHLY with the following criteria:

• 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:
  1. Use sentence case, capitalizing only the first word.
  2. 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.
  3. 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 reviewing capitalization, always refer to the 'nouns.txt' file for the correct capitalization of proper nouns and technical terms specific to the project.
  "

🔇 Additional comments (2)

pages/chain/testing/dev-node.mdx (2)

76-76: Verify the optimism-package repository.

The command has been updated to use the correct package. Let's verify its existence and accessibility.

✅ Verification successful

The optimism-package repository is verified and accessible

The repository exists at github.com/ethpandaops/optimism-package and contains the necessary Kurtosis configuration for deploying an optimistic rollup. The package is actively maintained and includes comprehensive configuration options for deploying L2 networks.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the existence and accessibility of the optimism-package repository
# Expected: Repository should be public and contain kurtosis configuration

# Check if the repository exists and is accessible
gh repo view ethpandaops/optimism-package

# Search for kurtosis configuration files
rg -g '*.star' -g '*.yaml' 'network_id|optimism_package'

Length of output: 16282

---

66-66: LGTM: Parameter name change is correct.

The change from chain_id to network_id accurately reflects the expected parameter name in the configuration.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.
  • Generate unit testing code for this file.
  • 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 generate unit testing code for this file.
  • @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 generate unit testing code.
  • @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.

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

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.