Update "Running a Local Development Environment" Tutorial #1538
Conversation
✅ Deploy Preview for docs-optimism ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThis pull request updates documentation related to the development network and L2 interactions. In the "Debug before deploying" section of the app developers’ guide, the URL for the development network has been changed from Assessment against linked issues
Possibly related PRs
Suggested labels
Suggested reviewers
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
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 (3)
pages/operators/chain-operators/tutorials/chain-dev-net.mdx (3)
175-186: Improved instructions for checking L2 balanceThe updated instructions provide clearer steps with environment variables and explicit commands for checking the balance on L2, which is more user-friendly.
Consider adding additional clarification for the L2 RPC port placeholder:
-export L2_RPC_URL="http://127.0.0.1:<L2-RPC-PORT>" # Replace with your actual L2 RPC port +export L2_RPC_URL="http://127.0.0.1:<L2-RPC-PORT>" # Replace <L2-RPC-PORT> with the port number from the op-el service (e.g., 33643)
190-204: Helpful new section on L2 interactionThe added section with examples for sending transactions and deploying contracts provides valuable practical guidance for users. This aligns with the PR objectives to improve the tutorial's usability.
Consider providing more specific guidance for the placeholder values:
- <RECIPIENT-ADDRESS> \ + <RECIPIENT-ADDRESS> \ # Replace with any Ethereum address you want to send to
215-215: Improved troubleshooting resourcesAdding a reference to the Optimism Discord provides users with an additional support option beyond just filing GitHub issues, which enhances the troubleshooting section.
The sentence contains a repeated "please" which could be simplified:
-* If you run into any problems, please [file an issue](https://github.com/ethereum-optimism/optimism/issues) or join the [Optimism Discord](https://discord.optimism.io/) for help. +* If you run into any problems, [file an issue](https://github.com/ethereum-optimism/optimism/issues) or join the [Optimism Discord](https://discord.optimism.io/) for help.🧰 Tools
🪛 LanguageTool
[style] ~215-~215: This sentence already contains the adverb “please”. Consider removing one of them.
Context: ...ting) * If you run into any problems, please [file an issue](https://github.com/ethe...(REPEATED_PLEASE)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (5)
pages/app-developers/building-apps.mdx(1 hunks)pages/operators/chain-operators/tutorials/chain-dev-net.mdx(2 hunks)pages/stack/dev-net.mdx(0 hunks)public/_redirects(1 hunks)words.txt(0 hunks)
💤 Files with no reviewable changes (2)
- words.txt
- pages/stack/dev-net.mdx
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.mdx`: "ALWAYS review Markdown content THOROUGHLY with the following criteria: - First, check the frontmatter section at the top of the file: 1. For regular pages, ensure AL...
**/*.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 reviewing capitalization, always refer to the 'nouns.txt' file for the correct capitalization of proper nouns and technical terms specific to the project.
"
pages/app-developers/building-apps.mdxpages/operators/chain-operators/tutorials/chain-dev-net.mdx
🪛 LanguageTool
pages/operators/chain-operators/tutorials/chain-dev-net.mdx
[grammar] ~170-~170: This phrase is duplicated. You should probably use “test test” only once.
Context: ...d development addresses on L2 using the `test test test test test test test test test test test junk...
(PHRASE_REPETITION)
[style] ~215-~215: This sentence already contains the adverb “please”. Consider removing one of them.
Context: ...ting) * If you run into any problems, please [file an issue](https://github.com/ethe...
(REPEATED_PLEASE)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - docs-optimism
- GitHub Check: Header rules - docs-optimism
- GitHub Check: Pages changed - docs-optimism
🔇 Additional comments (5)
pages/app-developers/building-apps.mdx (1)
64-64: Correctly updated URL for development networkThe link to the development network has been updated to point to the new location at
/operators/chain-operators/tutorials/chain-dev-net. This change aligns with the redirect rules that have been added.public/_redirects (1)
81-82: Good addition of redirect for development networkThe added redirect rule ensures that users following old links to
/stack/dev-netwill be correctly directed to the new location at/chain-operators/tutorials/chain-dev-net. This redirect is properly formatted and maintains good user experience by preventing broken links.pages/operators/chain-operators/tutorials/chain-dev-net.mdx (3)
164-168: Clear improvement in section title and explanatory calloutThe section title has been updated to better reflect the actual process - using pre-funded accounts rather than depositing funds. The added callout provides important clarification that accounts are automatically pre-funded on L2, eliminating confusion about the need to bridge funds from L1.
170-174: Clear explanation of pre-funded accounts setupThe text provides helpful context about the pre-funded development addresses and the mnemonic used, which aligns with the PR objectives to improve clarity in the tutorial.
🧰 Tools
🪛 LanguageTool
[grammar] ~170-~170: This phrase is duplicated. You should probably use “test test” only once.
Context: ...d development addresses on L2 using the `test test test test test test test test test test test junk...(PHRASE_REPETITION)
188-189: Clear confirmation about pre-funded accountsThis additional text helps users understand what to expect when checking their balance, confirming that the account should already have ETH on L2.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
pages/operators/chain-operators/tutorials/chain-dev-net.mdx (3)
23-23: Header Style: Use Sentence Case for H1
The H1 header currently reads "Running a Local Development Environment." According to our style guidelines for headers, consider using sentence case (e.g., "Running a local development environment") to maintain consistency across documentation.-# Running a Local Development Environment +# Running a local development environment
178-182: Test Mnemonic Presentation: Consider Clarifying the Repetition
The sentence"Your network is configured to pre-fund development addresses on L2 using the
test test test test test test test test test test test junkmnemonic."
uses a repetitive pattern that, while standard as a BIP39 test mnemonic, might appear duplicated to some readers. Consider clarifying that this is the well-known test mnemonic to avoid confusion.-using the `test test test test test test test test test test test junk` mnemonic. +using the standard BIP39 test mnemonic `test test test test test test test test test test test junk`.🧰 Tools
🪛 LanguageTool
[grammar] ~178-~178: This phrase is duplicated. You should probably use “test test” only once.
Context: ...d development addresses on L2 using the `test test test test test test test test test test test junk...(PHRASE_REPETITION)
221-224: Next Steps: Refine Repetitive 'please' Usage
In the bullet point that reads:
"* If you run into any problems, please file an issue or join the Optimism Discord for help."
the word "please" appears redundantly. Consider removing one instance to streamline the sentence.-* If you run into any problems, please [file an issue](https://github.com/ethereum-optimism/optimism/issues) or join the [Optimism Discord](https://discord.optimism.io/) for help. +* If you run into any problems, [file an issue](https://github.com/ethereum-optimism/optimism/issues) or join the [Optimism Discord](https://discord.optimism.io/) for help.🧰 Tools
🪛 LanguageTool
[style] ~223-~223: This sentence already contains the adverb “please”. Consider removing one of them.
Context: ...ting) * If you run into any problems, please [file an issue](https://github.com/ethe...(REPEATED_PLEASE)
📜 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(2 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.mdx`: "ALWAYS review Markdown content THOROUGHLY with the following criteria: - First, check the frontmatter section at the top of the file: 1. For regular pages, ensure AL...
**/*.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 reviewing capitalization, always refer to the 'nouns.txt' file for the correct capitalization of proper nouns and technical terms specific to the project.
"
pages/operators/chain-operators/tutorials/chain-dev-net.mdx
🪛 LanguageTool
pages/operators/chain-operators/tutorials/chain-dev-net.mdx
[grammar] ~178-~178: This phrase is duplicated. You should probably use “test test” only once.
Context: ...d development addresses on L2 using the `test test test test test test test test test test test junk...
(PHRASE_REPETITION)
[style] ~223-~223: This sentence already contains the adverb “please”. Consider removing one of them.
Context: ...ting) * If you run into any problems, please [file an issue](https://github.com/ethe...
(REPEATED_PLEASE)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - docs-optimism
- GitHub Check: Header rules - docs-optimism
- GitHub Check: Pages changed - docs-optimism
🔇 Additional comments (5)
pages/operators/chain-operators/tutorials/chain-dev-net.mdx (5)
1-18: Frontmatter Verification: Metadata is Complete and Correct
The frontmatter contains all the required fields (title, description, lang, content_type, topic, personas, and categories) with non-empty values.
157-163: Kurtosis Web UI Callout: Clear and Helpful
The newly added callout that explains using the Kurtosis Web UI is clear and valuable for users who prefer a graphical interface.
174-177: L2 Pre-funding Callout: Clarity on Funding Behavior
The callout clearly informs users that the setup script automatically pre-funds accounts on L2, eliminating the need to bridge from L1. This aligns well with the PR objectives.
185-194: L2 Balance Check: Clear and Actionable Example
The code block for checking the L2 balance is clear and includes helpful comments (e.g., reminding users to replace<L2-RPC-PORT>with their actual port).
202-212: L2 Transaction Example: Well Documented
The examples for sending a transaction and deploying a contract on L2 are clear and instructive. The use ofcastis appropriate for the intended audience.
Description
This PR addresses the issues identified in #1327 regarding the "Running a Local Development Environment" tutorial.
Changes:
Tests
Additional context
Metadata