Update L2 Testnet Tutorial to Use Latest Releases #1304
Conversation
✅ Deploy Preview for docs-optimism ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
krofax
changed the title
📝 WalkthroughWalkthroughThis update revises the "Creating Your Own L2 Rollup Testnet" tutorial. The document now shifts the approach from building the OP Stack chain from source code to using pre-built binaries from the latest Optimism release. Detailed instructions for downloading, verifying (including checksum verification), and extracting the required binaries for Sequence Diagram(s)sequenceDiagram
participant U as User
participant T as Tutorial Page
participant R as Releases Page
U->>T: Open L2 Rollup Tutorial
T->>U: Display updated instructions for pre-built binaries
U->>R: Download latest op-node, op-batcher, op-proposer binaries
U->>U: Verify binaries using checksum instructions
U->>U: Extract binaries and prepare environment for OP Stack testnet setup
Possibly related issues
Possibly related PRs
Suggested labels
Suggested reviewers
Tip 🌐 Web search-backed reviews and chat
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? 🪧 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: 2
🧹 Nitpick comments (2)
pages/builders/chain-operators/tutorials/create-l2-rollup.mdx (2)
89-90: Improve clarity of binary usage explanation.The explanation of using pre-built binaries could be more specific about the benefits.
-You're going to be spinning up your OP Stack chain using pre-built binaries from the latest Optimism release instead of building directly from source. -This simplifies the setup process and ensures you're using the latest stable version. +You'll be using pre-built binaries from the latest Optimism release instead of building from source. +This approach simplifies setup, ensures stability, and reduces compilation time while providing the latest stable version.
170-172: Add error handling guidance for version checks.The version verification commands should include expected output and troubleshooting steps.
-op-node --version -op-batcher --version -op-proposer --version +# Verify each component's version matches the downloaded release +op-node --version # Should match the downloaded release version +op-batcher --version # Should match the downloaded release version +op-proposer --version # Should match the downloaded release version + +# If any command fails, ensure: +# 1. The binary is correctly extracted +# 2. The binary has execute permissions +# 3. The binary is in your system PATH
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
pages/builders/chain-operators/tutorials/create-l2-rollup.mdx(3 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
pages/builders/chain-operators/tutorials/create-l2-rollup.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:
- 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.
"
⏰ Context from checks skipped due to timeout of 90000ms (4)
- GitHub Check: Redirect rules - docs-optimism
- GitHub Check: Header rules - docs-optimism
- GitHub Check: Pages changed - docs-optimism
- GitHub Check: pr-workflow
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (2)
pages/builders/chain-operators/tutorials/create-l2-rollup.mdx (2)
12-12: Improve document structure and clarity.The tutorial's organization could be enhanced:
- The title should maintain proper capitalization of "L2" and "OP Stack" as technical terms
- The build section's introduction (lines 89-90) should be a separate callout for better visibility
Apply these changes:
-# Creating your own L2 rollup testnet +# Creating Your Own L2 Rollup Testnet -You're going to be spinning up your OP Stack chain using pre-built binaries from the latest Optimism release instead of building directly from source. -This simplifies the setup process and ensures you're using the latest stable version. +<Callout type="info"> + You're going to be spinning up your OP Stack chain using pre-built binaries from the latest Optimism release instead of building directly from source. + This simplifies the setup process and ensures you're using the latest stable version. +</Callout>Also applies to: 89-90
19-20: Improve writing style and grammar.Several style improvements are needed for better readability and professionalism.
Apply these changes:
-This tutorial is **designed for developers** who want to learn +This tutorial is **intended for developers** who want to learn -teach you all of the components +teach you all the components -To learn about the different components please +To learn about the different components, please -configuration file inside of the +configuration file inside the -blocks being created inside of +blocks being created insideAlso applies to: 23-23, 389-389, 644-644
🧰 Tools
🪛 LanguageTool
[style] ~19-~19: Consider using an alternative to strengthen your wording.
Context: ...rial is designed for developers who want to learn about the OP Stack by spinning...(WANT_KEEN)
[style] ~20-~20: Consider removing “of” to be more concise
Context: ...e full deployment process and teach you all of the components that make up the OP Stack, a...(ALL_OF_THE)
[style] ~20-~20: Try using a synonym here to elevate your writing.
Context: ...nd teach you all of the components that make up the OP Stack, and **you'll end up with ...(CONSTITUTE_COMPRISE)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
pages/builders/chain-operators/tutorials/create-l2-rollup.mdx(14 hunks)words.txt(0 hunks)
💤 Files with no reviewable changes (1)
- words.txt
🧰 Additional context used
📓 Path-based instructions (1)
pages/builders/chain-operators/tutorials/create-l2-rollup.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:
- 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.
"
🪛 LanguageTool
pages/builders/chain-operators/tutorials/create-l2-rollup.mdx
[style] ~19-~19: Consider using an alternative to strengthen your wording.
Context: ...rial is designed for developers who want to learn about the OP Stack by spinning...
(WANT_KEEN)
[style] ~20-~20: Consider removing “of” to be more concise
Context: ...e full deployment process and teach you all of the components that make up the OP Stack, a...
(ALL_OF_THE)
[style] ~20-~20: Try using a synonym here to elevate your writing.
Context: ...nd teach you all of the components that make up the OP Stack, and **you'll end up with ...
(CONSTITUTE_COMPRISE)
[typographical] ~23-~23: Consider adding a comma here.
Context: ... To learn about the different components please read the [deployment overview page](/bu...
(PLEASE_COMMA)
[uncategorized] ~27-~27: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...r own needs. **The OP Stack is free and open source software licensed entirely under the MI...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[style] ~389-~389: This phrase is redundant. Consider using “inside”.
Context: ...etting-started.jsonconfiguration file inside of thedeploy-config` directory. ```ba...
(OUTSIDE_OF)
[uncategorized] ~422-~422: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...69 then the contract has been deployed and you can safely skip this section. {<...
(COMMA_COMPOUND_SENTENCE)
[style] ~644-~644: This phrase is redundant. Consider using “inside”.
Context: ...ou'll start to see blocks being created inside of op-geth. ...
(OUTSIDE_OF)
🪛 Gitleaks (8.21.2)
pages/builders/chain-operators/tutorials/create-l2-rollup.mdx
287-287: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
291-291: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
295-295: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
299-299: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
⏰ Context from checks skipped due to timeout of 90000ms (4)
- GitHub Check: Redirect rules - docs-optimism
- GitHub Check: Header rules - docs-optimism
- GitHub Check: Pages changed - docs-optimism
- GitHub Check: pr-workflow
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (9)
pages/builders/chain-operators/tutorials/create-l2-rollup.mdx (9)
15-16: Informative callout text.
The callout instructing users to “be prepared to set aside approximately one hour” is helpful. Consider verifying that the emphasis is necessary and the wording reads smoothly.
24-24: Link clarity suggestion.
The prompt “read the deployment overview page” is clear; however, adding a comma after “please” may improve readability.
70-71: Direnv configuration callout improvement.
The callout explaining how to modify your shell configuration (e.g. “modify your shell configuration file (like~/.bashrcor~/.zshrc)”) is useful. Consider adding a comma after “file” for enhanced readability.
94-96: Work directory callout.
The instructions regarding using the home directory (i.e.~/) are clear. For improved readability, consider splitting the second sentence or adding a brief pause (e.g. a comma) between ideas.
351-386: Loading environment variables via direnv.
The steps to load the environment (including thedirenv allowcommand and its accompanying callouts) are clear. Consider revising sentence structure in the callouts (for example, adding commas where needed) to improve readability per style recommendations.🧰 Tools
🪛 LanguageTool
[uncategorized] ~364-~364: Possible missing comma found.
Context: ...](#configuring-direnv). Next you'll need to allowdirenvto read t...(AI_HYDRA_LEO_MISSING_COMMA)
457-473: Deploying the factory contract.
The longcast publishcommand is clearly documented; however, consider splitting it over multiple lines in the rendered documentation to improve readability.
525-532: JWT authentication key generation.
The command usingopenssl rand -hex 32 > jwt.txtis simple and understandable. Consider including a brief note on why this JWT is critical for the secure communication between clients.🧰 Tools
🪛 LanguageTool
[uncategorized] ~527-~527: Possible missing comma found.
Context: ...3>Create an authentication key} Next you'll create a [JSON Web Token](https:...(AI_HYDRA_LEO_MISSING_COMMA)
639-688: Running op-node explanation.
The instructions for launching op-node—including the configuration options and callouts regarding peer-to-peer synchronization—are comprehensive. You might emphasize that the--p2p.disableflag is used for initial testnet setup and can be reconfigured once the network scales.🧰 Tools
🪛 LanguageTool
[style] ~669-~669: This phrase is redundant. Consider using “inside”.
Context: ...ou'll start to see blocks being created inside ofop-geth. ...(OUTSIDE_OF)
19-20: Overall style and punctuation enhancements.
Static analysis has flagged several style improvements across the document:
• Consider alternative phrasings in lines 19–20 to remove redundancy (e.g. “designed for developers” might be reworded slightly for clarity).
• Insert a comma after introductory phrases in line 23 and review punctuation in compound sentences (see lines 335 and 447).
• Replace phrases like “inside of” with “inside” (as noted around lines 414 and 669).
• Ensure consistency in punctuation (for example, adding a comma in line 527).
These refinements will improve the document’s overall readability.Also applies to: 23-23, 335-335, 364-364, 414-414, 447-447, 527-527, 669-669
🧰 Tools
🪛 LanguageTool
[style] ~19-~19: Consider using an alternative to strengthen your wording.
Context: ...rial is designed for developers who want to learn about the OP Stack by spinning...(WANT_KEEN)
[style] ~20-~20: Consider removing “of” to be more concise
Context: ...e full deployment process and teach you all of the components that make up the OP Stack, a...(ALL_OF_THE)
[style] ~20-~20: Try using a synonym here to elevate your writing.
Context: ...nd teach you all of the components that make up the OP Stack, and **you'll end up with ...(CONSTITUTE_COMPRISE)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
pages/builders/chain-operators/tutorials/create-l2-rollup.mdx(14 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.mdx`: "ALWAYS review Markdown content THOROUGHLY with ...
**/*.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:
- 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/builders/chain-operators/tutorials/create-l2-rollup.mdx
🪛 LanguageTool
pages/builders/chain-operators/tutorials/create-l2-rollup.mdx
[style] ~19-~19: Consider using an alternative to strengthen your wording.
Context: ...rial is designed for developers who want to learn about the OP Stack by spinning...
(WANT_KEEN)
[style] ~20-~20: Consider removing “of” to be more concise
Context: ...e full deployment process and teach you all of the components that make up the OP Stack, a...
(ALL_OF_THE)
[style] ~20-~20: Try using a synonym here to elevate your writing.
Context: ...nd teach you all of the components that make up the OP Stack, and **you'll end up with ...
(CONSTITUTE_COMPRISE)
[typographical] ~23-~23: Consider adding a comma here.
Context: ... To learn about the different components please read the [deployment overview page](/bu...
(PLEASE_COMMA)
[uncategorized] ~27-~27: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...r own needs. **The OP Stack is free and open source software licensed entirely under the MI...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~335-~335: Possible missing comma found.
Context: ...need to send any ETH to the Sequencer address as it does not send transactions.** ...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~364-~364: Possible missing comma found.
Context: ...](#configuring-direnv). Next you'll need to allow direnv to read t...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~414-~414: This phrase is redundant. Consider using “inside”.
Context: ...etting-started.jsonconfiguration file inside of thedeploy-config` directory. ```ba...
(OUTSIDE_OF)
[uncategorized] ~447-~447: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...69 then the contract has been deployed and you can safely skip this section. {<...
(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~527-~527: Possible missing comma found.
Context: ...3>Create an authentication key} Next you'll create a [JSON Web Token](https:...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~669-~669: This phrase is redundant. Consider using “inside”.
Context: ...ou'll start to see blocks being created inside of op-geth. ...
(OUTSIDE_OF)
🪛 Gitleaks (8.21.2)
pages/builders/chain-operators/tutorials/create-l2-rollup.mdx
312-312: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
316-316: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
320-320: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
324-324: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
⏰ Context from checks skipped due to timeout of 90000ms (4)
- GitHub Check: Redirect rules - docs-optimism
- GitHub Check: Header rules - docs-optimism
- GitHub Check: Pages changed - docs-optimism
- GitHub Check: pr-workflow
🔇 Additional comments (17)
pages/builders/chain-operators/tutorials/create-l2-rollup.mdx (17)
12-12: Header update is clear.
The new level‑1 header “# Creating your own L2 rollup testnet” is concise and matches the document’s intent.
59-59: Section header consistency.
The updated header “####direnv” is clear and maintains consistency with the other dependency sections.
89-90: Explanation of pre‑built binaries.
The revised lines clarifying that users will be spinning up their OP Stack chain using pre‑built binaries are clear and benefit the reader by highlighting process simplification.
102-120: Repository cloning steps look solid.
The stepwise instructions covering the clone, branch creation, and package file setup are methodical and easy to follow.
121-209: Comprehensive package configuration.
The newpackage.jsoncontent is detailed and well formatted. Please verify that version specifications (for example,"nx-cloud": "latest") are intentional. Pinning versions where possible might improve production stability.
229-247: op-geth cloning and build instructions.
The steps to clone op-geth and to build it (make geth) are clear and correctly sequenced.
254-274: Environment variables setup is clear.
The instructions—and accompanying table—for filling out environment variables (e.g.L1_RPC_URLandL1_RPC_KIND) read clearly. Ensure that the table renders properly on all devices.
394-424: Network configuration instructions.
The new steps for entering the Optimism monorepo, moving into the contracts-bedrock package, installing Foundry dependencies, generating the configuration file, and reviewing it are detailed and instructive.🧰 Tools
🪛 LanguageTool
[style] ~414-~414: This phrase is redundant. Consider using “inside”.
Context: ...etting-started.jsonconfiguration file inside of thedeploy-config` directory. ```ba...(OUTSIDE_OF)
432-448: Create2 factory deployment (optional) improvement.
The optional section on deploying the Create2 factory is clear. It might be useful to emphasize when this step is necessary versus when it can be skipped.🧰 Tools
🪛 LanguageTool
[uncategorized] ~447-~447: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...69then the contract has been deployed and you can safely skip this section. {<...(COMMA_COMPOUND_SENTENCE)
481-493: Deploy L1 contracts instructions.
The deployment instructions for the L1 contracts, along with the helpful note about potentialEvmError: Revertissues related toIMPL_SALT, are well explained.
506-523: Genesis and rollup files generation.
The steps to create thegenesis.jsonandrollup.jsonfiles are clear and precise. Double-check that all relative paths work correctly in varied setups.
535-542: Copying genesis files.
The instructions to copy the generatedgenesis.jsonandjwt.txtinto the op-geth directory are concise and clear.
553-575: op-geth initialization process.
The step-by-step guide to navigate to op-geth, create the data directory, build the binary, and initialize the node is well documented.
584-629: op-geth startup command.
The detailedgethrun command with all its flags is thorough. It is advisable to verify that all file paths, such as tojwt.txt, and networking parameters (e.g.--networkid=42069) are suitable for the intended tutorial environment.
701-728: op-batcher execution steps.
The commands and explanations for running op-batcher are clear. The detailed description of the--max-channel-durationsetting aids in understanding its implications for cost and synchronization.
743-764: op-proposer operational instructions.
The stepwise guide to start op-proposer is clear, and the command format is consistent with the rest of the tutorial. Ensure that any references to environment variables (like$GS_PROPOSER_PRIVATE_KEY) remain secure and are documented as test values if applicable.
778-795: Getting ETH on your chain steps.
The instructions for obtaining Sepolia ETH using the L1StandardBridge are concise and actionable. Consider adding a troubleshooting tip if users experience delays in ETH appearing on L2.
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (6)
pages/builders/chain-operators/tutorials/create-l2-rollup.mdx (6)
15-16: Clear and engaging information callout
The callout text asking users to set aside approximately one hour is concise and helpful. Consider, however, whether a slightly more active tone (e.g., "Allocate approximately one hour…") might improve clarity.
22-24: Punctuation for better readability
In the sentence spanning lines 22–24—specifically before the directive "read the deployment overview page"—adding a comma after "components" could help clarify the instruction. For example:"To learn about the different components, please read the [deployment overview page]…"
🧰 Tools
🪛 LanguageTool
[typographical] ~23-~23: Consider adding a comma here.
Context: ... To learn about the different components please read the [deployment overview page](/bu...(PLEASE_COMMA)
19-21: Improve sentence structure and voice
The description in lines 19–21 is informative but can be made more direct. For instance, consider rephrasing to:"This tutorial targets developers who wish to explore the OP Stack by deploying a testnet chain. It guides you through the deployment process and culminates in the creation of your own OP Stack testnet."
This revision uses an active voice and streamlines the explanation.🧰 Tools
🪛 LanguageTool
[style] ~19-~19: Consider using an alternative to strengthen your wording.
Context: ...rial is designed for developers who want to learn about the OP Stack by spinning...(WANT_KEEN)
[style] ~20-~20: Consider removing “of” to be more concise
Context: ...e full deployment process and teach you all of the components that make up the OP Stack, a...(ALL_OF_THE)
[style] ~20-~20: Try using a synonym here to elevate your writing.
Context: ...nd teach you all of the components that make up the OP Stack, and **you'll end up with ...(CONSTITUTE_COMPRISE)
414-414: Refine phrasing for conciseness
In line 414, the phrase "inside of thedeploy-configdirectory" can be streamlined to "inside thedeploy-configdirectory" for brevity and clarity.🧰 Tools
🪛 LanguageTool
[style] ~414-~414: This phrase is redundant. Consider using “inside”.
Context: ...etting-started.jsonconfiguration file inside of thedeploy-config` directory. ```ba...(OUTSIDE_OF)
442-447: Punctuation for clarity in instructions
In the explanation regarding the Create2 factory (lines 442–447), consider adding a comma before "and" in the sentence "If the command returns69then the contract has been deployed and you can safely skip this section." This will help delineate the independent clauses for improved readability.🧰 Tools
🪛 LanguageTool
[uncategorized] ~447-~447: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...69then the contract has been deployed and you can safely skip this section. {<...(COMMA_COMPOUND_SENTENCE)
669-669: Concise language suggestion for directory reference
In the op-geth section, the phrase "inside ofop-geth" (line 669) could be more concise if changed to "insideop-geth".🧰 Tools
🪛 LanguageTool
[style] ~669-~669: This phrase is redundant. Consider using “inside”.
Context: ...ou'll start to see blocks being created inside ofop-geth. ...(OUTSIDE_OF)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
pages/builders/chain-operators/tutorials/create-l2-rollup.mdx(14 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.mdx`: "ALWAYS review Markdown content THOROUGHLY with ...
**/*.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:
- 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/builders/chain-operators/tutorials/create-l2-rollup.mdx
🪛 LanguageTool
pages/builders/chain-operators/tutorials/create-l2-rollup.mdx
[style] ~19-~19: Consider using an alternative to strengthen your wording.
Context: ...rial is designed for developers who want to learn about the OP Stack by spinning...
(WANT_KEEN)
[style] ~20-~20: Consider removing “of” to be more concise
Context: ...e full deployment process and teach you all of the components that make up the OP Stack, a...
(ALL_OF_THE)
[style] ~20-~20: Try using a synonym here to elevate your writing.
Context: ...nd teach you all of the components that make up the OP Stack, and **you'll end up with ...
(CONSTITUTE_COMPRISE)
[typographical] ~23-~23: Consider adding a comma here.
Context: ... To learn about the different components please read the [deployment overview page](/bu...
(PLEASE_COMMA)
[uncategorized] ~27-~27: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...r own needs. **The OP Stack is free and open source software licensed entirely under the MI...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[style] ~414-~414: This phrase is redundant. Consider using “inside”.
Context: ...etting-started.jsonconfiguration file inside of thedeploy-config` directory. ```ba...
(OUTSIDE_OF)
[uncategorized] ~447-~447: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...69 then the contract has been deployed and you can safely skip this section. {<...
(COMMA_COMPOUND_SENTENCE)
[style] ~669-~669: This phrase is redundant. Consider using “inside”.
Context: ...ou'll start to see blocks being created inside of op-geth. ...
(OUTSIDE_OF)
🪛 Gitleaks (8.21.2)
pages/builders/chain-operators/tutorials/create-l2-rollup.mdx
312-312: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
316-316: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
320-320: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
324-324: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
⏰ Context from checks skipped due to timeout of 90000ms (4)
- GitHub Check: Redirect rules - docs-optimism
- GitHub Check: Header rules - docs-optimism
- GitHub Check: Pages changed - docs-optimism
- GitHub Check: pr-workflow
🔇 Additional comments (2)
pages/builders/chain-operators/tutorials/create-l2-rollup.mdx (2)
12-12: Redundant H1 header after front matter
The document’s front matter already defines the title. Double-check whether the repeated H1 ("Creating your own L2 rollup testnet") is intentional as part of the design or if it might be redundant.
89-90: Clear update on build process
The modified text in lines 89–90 effectively communicates the shift from building from source to using pre-built binaries from the latest Optimism release. The simplified setup process is clearly explained.
Description
Summary
This PR updates the L2 Testnet Tutorial to ensure that users download and use the latest released versions of
op-node,op-batcher, andop-proposerfrom the Optimism releases page, instead of relying on the outdated tutorials/chain branch.Changes Made
tutorials/chainbranch contains outdated components.Tests
Additional context
Metadata