docs: Update L1 and L2 URL examples for op-node setup

[WillPapper]

Description

The tutorial for setting up op-node does not give URL and port examples for its environment variables, which can make it difficult to figure out which URLs should be used. I gave the default ports used by Geth/Reth and Prysm local nodes respectively.

In addition, the op-node documentation does not state that Geth/Reth use different terminology from op-node when referring to the Engine API. I specified that when Geth/Reth refer to the authrpc parameter, they are referring to the same value used by the L2 Engine JSON-RPC endpoint.

Tests

Confirmed that all changes format well visually and pass all lint checks

Additional context

N/A

Metadata

N/A

[coderabbitai]

Walkthrough

This update modifies the address format for L1 beacon nodes from an IP address alone to include the HTTP protocol, ensuring clarity and consistency in endpoint specifications. Additionally, explanations are enhanced for environment variables in both mainnet and testnet tutorials, specifically addressing the typical URLs used for local nodes.

Changes

File	Change Summary
pages/builders/node-operators/configuration/consensus-config.mdx	Updated address format for L1 beacon nodes to include HTTP protocol and clarified L2 Engine JSON-RPC endpoints with authrpc alias.
pages/builders/node-operators/tutorials/mainnet.mdx	Enhanced environment variable descriptions for L1_RPC_URL and L1_BEACON_URL to include common URLs for local nodes.
pages/builders/node-operators/tutorials/testnet.mdx	Enhanced environment variable descriptions for L1_RPC_URL and L1_BEACON_URL to include common URLs for local nodes.

Tip

AI model upgrade

gpt-4o model for reviews and chat is now live

OpenAI claims that this model is better at understanding and generating code than the previous models. Please join our Discord Community to provide any feedback or to report any issues.

---

Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 6b33e08 and d12dcd7.

Files selected for processing (3)

• pages/builders/node-operators/configuration/consensus-config.mdx (2 hunks)
• pages/builders/node-operators/tutorials/mainnet.mdx (1 hunks)
• pages/builders/node-operators/tutorials/testnet.mdx (1 hunks)

Files skipped from review due to trivial changes (2)

• pages/builders/node-operators/tutorials/mainnet.mdx
• pages/builders/node-operators/tutorials/testnet.mdx

Additional context used

Path-based instructions (1)

pages/builders/node-operators/configuration/consensus-config.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. Use bold for prominence instead of all caps or italics.
• Ensure proper nouns are capitalized in sentences.
• Apply the Oxford comma.
• Use proper title case for headers, 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).
  "

LanguageTool

pages/builders/node-operators/configuration/consensus-config.mdx

[style] ~98-~98: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...1.beacon="http://127.0.0.1:3500"`</Tabs.Tab> <Tabs.Tab>`OP_NODE_L1_BEACON="http:/...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)

Additional comments not posted (2)

pages/builders/node-operators/configuration/consensus-config.mdx (2)

98-99: Reword for better readability.

Avoid starting successive sentences with the same word. Consider rewording the sentence for better readability.
[STYLE]

-  <Tabs.Tab>`--l1.beacon="http://127.0.0.1:3500"`</Tabs.Tab>
-  <Tabs.Tab>`OP_NODE_L1_BEACON="http://127.0.0.1:3500"`</Tabs.Tab>
+  <Tabs.Tab>`--l1.beacon="http://127.0.0.1:3500"`</Tabs.Tab>
+  <Tabs.Tab>`OP_NODE_L1_BEACON="http://127.0.0.1:3500"`</Tabs.Tab> (default)

Tools

LanguageTool

[style] ~98-~98: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...1.beacon="http://127.0.0.1:3500"`</Tabs.Tab> <Tabs.Tab>`OP_NODE_L1_BEACON="http:/...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)

---

214-214: LGTM!

The changes provide clear and useful examples for L2 Engine JSON-RPC endpoints and clarify the terminology used by Geth and Reth.

---

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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.

[netlify]

✅ Deploy Preview for docs-optimism ready!

Name	Link
🔨 Latest commit	d12dcd7
🔍 Latest deploy log	https://app.netlify.com/sites/docs-optimism/deploys/66856c923a5d3d000878ea88
😎 Deploy Preview	https://deploy-preview-781--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.