Skip to content

Conversation

krofax
Copy link
Collaborator

@krofax krofax commented Jul 16, 2025

Description

This PR standardizes explorer URLs throughout the documentation to ensure consistency and prevent broken links or redirects.

Tests

Additional context

Metadata

@krofax krofax requested a review from a team as a code owner July 16, 2025 13:05
Copy link

netlify bot commented Jul 16, 2025

Deploy Preview for docs-optimism ready!

Name Link
🔨 Latest commit 52c5fb7
🔍 Latest deploy log https://app.netlify.com/projects/docs-optimism/deploys/687922f93a64e800088dd4c7
😎 Deploy Preview https://deploy-preview-1693--docs-optimism.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

Copy link
Contributor

coderabbitai bot commented Jul 16, 2025

📝 Walkthrough

Walkthrough

This change updates all references to the OP Mainnet and OP Sepolia blockchain explorers from previous Etherscan-based domains (such as https://optimistic.etherscan.io and https://sepolia-optimism.etherscan.io) to the new official Optimism explorers (https://explorer.optimism.io and https://testnet-explorer.optimism.io) across both documentation and code. The modifications affect multiple markdown documentation files, TypeScript constants, and configuration files, ensuring consistent use of the new explorer URLs. Additional minor editorial updates include markdown formatting fixes and adjustments to a word list. No changes were made to logic, control flow, or exported/public entities.

Possibly related PRs

  • Correct tokenlist #1342: Updates terminology from "OP Stack chains" to "OP Mainnet" in tokenlist.mdx, modifying related content within the same file as this PR.
  • privileged-roles address updates #753: Updates Ethereum address links and adds address aliasing details in privileged-roles.mdx, which is also modified by this PR to update explorer URLs.

Suggested labels

flag:merge-pending-release

✨ Finishing Touches
  • 📝 Generate Docstrings

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.

❤️ Share
🪧 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🔭 Outside diff range comments (1)
components/TokenListTable.tsx (1)

4-11: Normalize base URLs to prevent //address in generated links

explorers['420'], '11155111', and '11155420' still carry a trailing /.
Because the table builds links via ${explorers[id]}/address/..., these three entries produce a double slash (//address) while the others do not. Although browsers tolerate it, it is sloppy and can break some middleware that performs strict URL joins.

-  '420': 'https://goerli-optimism.etherscan.io',
-  '11155111': 'https://sepolia.etherscan.io/',
-  '11155420': 'https://sepolia-optimistic.etherscan.io/',
+  '420': 'https://goerli-optimism.etherscan.io',
+  '11155111': 'https://sepolia.etherscan.io',
+  '11155420': 'https://sepolia-optimistic.etherscan.io',

After trimming the slashes, every entry is consistent and safe to concatenate.

🧹 Nitpick comments (7)
pages/app-developers/tools/build/_meta.json (1)

22-23: Good update, but consider slug consistency

The href is updated correctly. If you later re-label this item from “OP Mainnet explorer” to something like “OP Stack explorer” (per style guidance), remember to adjust both title and downstream references in sidebar configs.

utils/networks.ts (1)

29-30: Standardize trailing-slash usage across explorer URLs

chains.opmainnet.explorer now omits the trailing slash, whereas chains.opsepolia.explorer (line 39) still contains one. The surrounding code treats these values as simple strings, so either variant works, but mixing them invites subtle string-concat bugs and produces uneven link formatting in the UI.

-    explorer: 'https://explorer.optimism.io',
+    explorer: 'https://explorer.optimism.io/',

(Apply the same convention everywhere—or strip the slash from the Sepolia URL.)

pages/app-developers/tools.mdx (1)

65-66: Nit: match trailing-slash convention

The newly-added OP Mainnet Explorer card uses a trailing slash (…io/), but the utils constants were switched to the no-slash variant. Consider aligning with whichever convention you adopt globally (see comment in utils/networks.ts).

pages/operators/node-operators/json-rpc.mdx (1)

28-32: Consider replacing “OP Mainnet” with “OP Stack” for consistency

Per house style (see past PR #1001), documentation should prefer “OP Stack” unless the text is explicitly chain-specific. Here the sentence discusses a generic recommendation, not the L1 chain itself, so “OP Stack components” would be more consistent.

utils/constants.ts (1)

40-42: Keep URL format consistent with utils/networks.ts

Same observation as above: decide on trailing-slash policy and apply it uniformly.

-    explorer: 'https://explorer.optimism.io',
+    explorer: 'https://explorer.optimism.io/',
pages/superchain/privileged-roles.mdx (1)

73-75: Inconsistent anchor usage may break links

The first explorer link (line 73) drops the #readProxyContract anchor, while later explorer links keep it (e.g., lines 209-214). Verify that the Optimism explorer supports this anchor and make the usage consistent—either include it everywhere or remove it everywhere.

pages/superchain/tokenlist.mdx (1)

41-44: Synchronize address casing for readability.
The address in the code span (0x0b2C639c...) mixes upper- and lower-case, while the hyperlink uses all lower-case. Although Ethereum addresses are case-insensitive, presenting the exact same casing in both places avoids reader confusion.

-| `USDC`   | Native USDC issued by Circle | [`0x0b2C639c533813f4Aa9D7837CAf62653d097Ff85`](https://explorer.optimism.io/token/0x0b2c639c533813f4aa9d7837caf62653d097ff85) |
+| `USDC`   | Native USDC issued by Circle | [`0x0b2c639c533813f4aa9d7837caf62653d097ff85`](https://explorer.optimism.io/token/0x0b2c639c533813f4aa9d7837caf62653d097ff85) |
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 22cf54f and efa41e4.

📒 Files selected for processing (12)
  • components/TokenListTable.tsx (1 hunks)
  • pages/app-developers/bridging/custom-bridge.mdx (1 hunks)
  • pages/app-developers/tools.mdx (1 hunks)
  • pages/app-developers/tools/build/_meta.json (1 hunks)
  • pages/operators/node-operators/json-rpc.mdx (1 hunks)
  • pages/stack/smart-contracts/smart-contracts.mdx (5 hunks)
  • pages/superchain/networks.mdx (1 hunks)
  • pages/superchain/privileged-roles.mdx (2 hunks)
  • pages/superchain/tokenlist.mdx (1 hunks)
  • utils/constants.ts (1 hunks)
  • utils/networks.ts (1 hunks)
  • words.txt (2 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
**/*.mdx

Instructions used from:

Sources:
⚙️ CodeRabbit Configuration File

🧠 Learnings (11)
📓 Common learnings
Learnt from: qbzzt
PR: ethereum-optimism/docs#1216
File: pages/stack/interop/security.mdx:136-144
Timestamp: 2025-01-08T11:04:45.361Z
Learning: In the ethereum-optimism/docs repository, sections that are commented out in documentation files are intentionally excluded due to accuracy concerns and should not be suggested for inclusion until the information becomes accurate.
Learnt from: sbvegan
PR: ethereum-optimism/docs#1001
File: pages/builders.mdx:11-12
Timestamp: 2024-10-22T02:58:02.175Z
Learning: Prefer using 'OP Stack' over 'OP Mainnet' in documentation for consistency.
Learnt from: qbzzt
PR: ethereum-optimism/docs#1613
File: public/tutorials/attest.mjs:64-71
Timestamp: 2025-05-24T18:24:46.628Z
Learning: For tutorial and educational code in the ethereum-optimism/docs repository, prioritize simplicity and clarity over production-level robustness. Hardcoded values and simplified error handling are acceptable when they help demonstrate core concepts without unnecessary complexity.
Learnt from: qbzzt
PR: ethereum-optimism/docs#1390
File: public/tutorials/CustomSuperchainToken.sol:32-38
Timestamp: 2025-02-20T16:55:42.917Z
Learning: In tutorial and example code for the ethereum-optimism/docs repository, prioritize code clarity and simplicity over additional security measures or optimizations, unless they are specifically part of the learning objectives.
pages/app-developers/bridging/custom-bridge.mdx (3)
Learnt from: qbzzt
PR: ethereum-optimism/docs#1613
File: public/tutorials/attest.mjs:64-71
Timestamp: 2025-05-24T18:24:46.628Z
Learning: For tutorial and educational code in the ethereum-optimism/docs repository, prioritize simplicity and clarity over production-level robustness. Hardcoded values and simplified error handling are acceptable when they help demonstrate core concepts without unnecessary complexity.
Learnt from: qbzzt
PR: ethereum-optimism/docs#1390
File: public/tutorials/CustomSuperchainToken.sol:32-38
Timestamp: 2025-02-20T16:55:42.917Z
Learning: In tutorial and example code for the ethereum-optimism/docs repository, prioritize code clarity and simplicity over additional security measures or optimizations, unless they are specifically part of the learning objectives.
Learnt from: qbzzt
PR: ethereum-optimism/docs#1216
File: pages/stack/interop/security.mdx:136-144
Timestamp: 2025-01-08T11:04:45.361Z
Learning: In the ethereum-optimism/docs repository, sections that are commented out in documentation files are intentionally excluded due to accuracy concerns and should not be suggested for inclusion until the information becomes accurate.
pages/app-developers/tools/build/_meta.json (2)
Learnt from: qbzzt
PR: ethereum-optimism/docs#1216
File: pages/stack/interop/security.mdx:136-144
Timestamp: 2025-01-08T11:04:45.361Z
Learning: In the ethereum-optimism/docs repository, sections that are commented out in documentation files are intentionally excluded due to accuracy concerns and should not be suggested for inclusion until the information becomes accurate.
Learnt from: sbvegan
PR: ethereum-optimism/docs#1001
File: pages/builders.mdx:11-12
Timestamp: 2024-10-22T02:58:02.175Z
Learning: Prefer using 'OP Stack' over 'OP Mainnet' in documentation for consistency.
pages/superchain/networks.mdx (3)
Learnt from: sbvegan
PR: ethereum-optimism/docs#1001
File: pages/builders.mdx:11-12
Timestamp: 2024-10-22T02:58:02.175Z
Learning: Prefer using 'OP Stack' over 'OP Mainnet' in documentation for consistency.
Learnt from: qbzzt
PR: ethereum-optimism/docs#1216
File: pages/stack/interop/security.mdx:136-144
Timestamp: 2025-01-08T11:04:45.361Z
Learning: In the ethereum-optimism/docs repository, sections that are commented out in documentation files are intentionally excluded due to accuracy concerns and should not be suggested for inclusion until the information becomes accurate.
Learnt from: qbzzt
PR: ethereum-optimism/docs#1613
File: public/tutorials/attest.mjs:64-71
Timestamp: 2025-05-24T18:24:46.628Z
Learning: For tutorial and educational code in the ethereum-optimism/docs repository, prioritize simplicity and clarity over production-level robustness. Hardcoded values and simplified error handling are acceptable when they help demonstrate core concepts without unnecessary complexity.
words.txt (1)
Learnt from: sbvegan
PR: ethereum-optimism/docs#1001
File: pages/builders.mdx:11-12
Timestamp: 2024-10-22T02:58:02.175Z
Learning: Prefer using 'OP Stack' over 'OP Mainnet' in documentation for consistency.
utils/networks.ts (3)
Learnt from: sbvegan
PR: ethereum-optimism/docs#1001
File: pages/builders.mdx:11-12
Timestamp: 2024-10-22T02:58:02.175Z
Learning: Prefer using 'OP Stack' over 'OP Mainnet' in documentation for consistency.
Learnt from: qbzzt
PR: ethereum-optimism/docs#1216
File: pages/stack/interop/security.mdx:136-144
Timestamp: 2025-01-08T11:04:45.361Z
Learning: In the ethereum-optimism/docs repository, sections that are commented out in documentation files are intentionally excluded due to accuracy concerns and should not be suggested for inclusion until the information becomes accurate.
Learnt from: qbzzt
PR: ethereum-optimism/docs#1613
File: public/tutorials/attest.mjs:64-71
Timestamp: 2025-05-24T18:24:46.628Z
Learning: For tutorial and educational code in the ethereum-optimism/docs repository, prioritize simplicity and clarity over production-level robustness. Hardcoded values and simplified error handling are acceptable when they help demonstrate core concepts without unnecessary complexity.
pages/app-developers/tools.mdx (3)
Learnt from: sbvegan
PR: ethereum-optimism/docs#1001
File: pages/builders.mdx:11-12
Timestamp: 2024-10-22T02:58:02.175Z
Learning: Prefer using 'OP Stack' over 'OP Mainnet' in documentation for consistency.
Learnt from: qbzzt
PR: ethereum-optimism/docs#1216
File: pages/stack/interop/security.mdx:136-144
Timestamp: 2025-01-08T11:04:45.361Z
Learning: In the ethereum-optimism/docs repository, sections that are commented out in documentation files are intentionally excluded due to accuracy concerns and should not be suggested for inclusion until the information becomes accurate.
Learnt from: qbzzt
PR: ethereum-optimism/docs#1613
File: public/tutorials/attest.mjs:64-71
Timestamp: 2025-05-24T18:24:46.628Z
Learning: For tutorial and educational code in the ethereum-optimism/docs repository, prioritize simplicity and clarity over production-level robustness. Hardcoded values and simplified error handling are acceptable when they help demonstrate core concepts without unnecessary complexity.
pages/superchain/privileged-roles.mdx (5)
Learnt from: qbzzt
PR: ethereum-optimism/docs#1216
File: pages/stack/interop/security.mdx:136-144
Timestamp: 2025-01-08T11:04:45.361Z
Learning: In the ethereum-optimism/docs repository, sections that are commented out in documentation files are intentionally excluded due to accuracy concerns and should not be suggested for inclusion until the information becomes accurate.
Learnt from: qbzzt
PR: ethereum-optimism/docs#1525
File: pages/stack/interop/tutorials/upgrade-to-superchain-erc20.mdx:500-503
Timestamp: 2025-04-03T01:38:08.988Z
Learning: Private keys in the "Upgrading ERC20 to SuperchainERC20" tutorial document are test/demo keys intentionally included for educational purposes and do not represent security concerns.
Learnt from: qbzzt
PR: ethereum-optimism/docs#1613
File: public/tutorials/attest.mjs:64-71
Timestamp: 2025-05-24T18:24:46.628Z
Learning: For tutorial and educational code in the ethereum-optimism/docs repository, prioritize simplicity and clarity over production-level robustness. Hardcoded values and simplified error handling are acceptable when they help demonstrate core concepts without unnecessary complexity.
Learnt from: qbzzt
PR: ethereum-optimism/docs#1390
File: public/tutorials/CustomSuperchainToken.sol:32-38
Timestamp: 2025-02-20T16:55:42.917Z
Learning: In tutorial and example code for the ethereum-optimism/docs repository, prioritize code clarity and simplicity over additional security measures or optimizations, unless they are specifically part of the learning objectives.
Learnt from: qbzzt
PR: ethereum-optimism/docs#1577
File: pages/interop/tutorials/upgrade-to-superchain-erc20/contract-upgrade.mdx:175-175
Timestamp: 2025-06-09T01:32:37.738Z
Learning: In Optimism documentation, code snippets can reference embedded code within shell scripts using line number ranges. For example, `file=<rootDir>/public/tutorials/setup-for-erc20-upgrade.sh#L26-L66` can correctly extract Solidity code that's embedded within a shell script, with the language identifier determining syntax highlighting regardless of the source file extension.
pages/superchain/tokenlist.mdx (2)
Learnt from: qbzzt
PR: ethereum-optimism/docs#1216
File: pages/stack/interop/security.mdx:136-144
Timestamp: 2025-01-08T11:04:45.361Z
Learning: In the ethereum-optimism/docs repository, sections that are commented out in documentation files are intentionally excluded due to accuracy concerns and should not be suggested for inclusion until the information becomes accurate.
Learnt from: sbvegan
PR: ethereum-optimism/docs#1001
File: pages/builders.mdx:11-12
Timestamp: 2024-10-22T02:58:02.175Z
Learning: Prefer using 'OP Stack' over 'OP Mainnet' in documentation for consistency.
pages/stack/smart-contracts/smart-contracts.mdx (9)
Learnt from: qbzzt
PR: ethereum-optimism/docs#1216
File: pages/stack/interop/security.mdx:136-144
Timestamp: 2025-01-08T11:04:45.361Z
Learning: In the ethereum-optimism/docs repository, sections that are commented out in documentation files are intentionally excluded due to accuracy concerns and should not be suggested for inclusion until the information becomes accurate.
Learnt from: smartcontracts
PR: ethereum-optimism/docs#241
File: public/tutorials/standard-bridge-standard-token.sh:3-6
Timestamp: 2024-10-13T07:16:50.980Z
Learning: User `smartcontracts` has requested that `.mdx` files always be reviewed according to the instructions in the `.yaml` configuration file. This preference should be remembered for future interactions.
Learnt from: smartcontracts
PR: ethereum-optimism/docs#241
File: public/tutorials/standard-bridge-standard-token.sh:3-6
Timestamp: 2024-06-10T19:38:04.907Z
Learning: User `smartcontracts` has requested that `.mdx` files always be reviewed according to the instructions in the `.yaml` configuration file. This preference should be remembered for future interactions.
Learnt from: qbzzt
PR: ethereum-optimism/docs#1613
File: public/tutorials/attest.mjs:64-71
Timestamp: 2025-05-24T18:24:46.628Z
Learning: EAS (Ethereum Attestation Service) error codes are considered extremely stable and unlikely to change, making hardcoded error handling acceptable in tutorial contexts.
Learnt from: qbzzt
PR: ethereum-optimism/docs#1613
File: public/tutorials/attest.mjs:64-71
Timestamp: 2025-05-24T18:24:46.628Z
Learning: For tutorial and educational code in the ethereum-optimism/docs repository, prioritize simplicity and clarity over production-level robustness. Hardcoded values and simplified error handling are acceptable when they help demonstrate core concepts without unnecessary complexity.
Learnt from: sbvegan
PR: ethereum-optimism/docs#1001
File: pages/builders.mdx:11-12
Timestamp: 2024-10-22T02:58:02.175Z
Learning: Prefer using 'OP Stack' over 'OP Mainnet' in documentation for consistency.
Learnt from: sbvegan
PR: ethereum-optimism/docs#536
File: pages/stack/protocol/smart-contracts.mdx:272-272
Timestamp: 2024-10-08T15:32:06.348Z
Learning: The ProtocolVersions release does not have a governance post because it is an optional feature.
Learnt from: sbvegan
PR: ethereum-optimism/docs#536
File: pages/stack/protocol/smart-contracts.mdx:272-272
Timestamp: 2024-06-10T19:38:04.907Z
Learning: The ProtocolVersions release does not have a governance post because it is an optional feature.
Learnt from: qbzzt
PR: ethereum-optimism/docs#1390
File: public/tutorials/CustomSuperchainToken.sol:32-38
Timestamp: 2025-02-20T16:55:42.917Z
Learning: In tutorial and example code for the ethereum-optimism/docs repository, prioritize code clarity and simplicity over additional security measures or optimizations, unless they are specifically part of the learning objectives.
pages/operators/node-operators/json-rpc.mdx (5)
Learnt from: qbzzt
PR: ethereum-optimism/docs#1216
File: pages/stack/interop/security.mdx:136-144
Timestamp: 2025-01-08T11:04:45.361Z
Learning: In the ethereum-optimism/docs repository, sections that are commented out in documentation files are intentionally excluded due to accuracy concerns and should not be suggested for inclusion until the information becomes accurate.
Learnt from: qbzzt
PR: ethereum-optimism/docs#1613
File: public/tutorials/attest.mjs:64-71
Timestamp: 2025-05-24T18:24:46.628Z
Learning: For tutorial and educational code in the ethereum-optimism/docs repository, prioritize simplicity and clarity over production-level robustness. Hardcoded values and simplified error handling are acceptable when they help demonstrate core concepts without unnecessary complexity.
Learnt from: sbvegan
PR: ethereum-optimism/docs#1001
File: pages/builders.mdx:11-12
Timestamp: 2024-10-22T02:58:02.175Z
Learning: Prefer using 'OP Stack' over 'OP Mainnet' in documentation for consistency.
Learnt from: cpengilly
PR: ethereum-optimism/docs#729
File: words.txt:17-17
Timestamp: 2024-10-08T15:32:06.348Z
Learning: The term "basefee" refers to the minimum price per unit of gas for including a transaction in a block, primarily used in Ethereum and introduced by EIP-1559.
Learnt from: cpengilly
PR: ethereum-optimism/docs#729
File: words.txt:17-17
Timestamp: 2024-06-17T16:39:18.422Z
Learning: The term "basefee" refers to the minimum price per unit of gas for including a transaction in a block, primarily used in Ethereum and introduced by EIP-1559.
⏰ 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 (10)
words.txt (1)

91-93: Additions look good – word-list remains alphabetically correct

The new lowercase variants slot into the correct alphabetical positions and keep the upper/lower-case pairing pattern used throughout the file. No further action required.

Also applies to: 268-268

pages/superchain/networks.mdx (1)

36-36: URL swap correct and live

The explorer link now targets the canonical Optimism explorer. Rendering and Markdown syntax look fine.

components/TokenListTable.tsx (1)

7-7: Correct domain for chain 10

Switching to https://explorer.optimism.io is accurate and aligns with the rest of the PR.

pages/app-developers/bridging/custom-bridge.mdx (1)

53-54: Explorer link updated – verify contract hash fragment

The base domain is correct, but the #code fragment can 404 if the new explorer uses a different tab slug. Quick sanity-check in the browser recommended.

pages/superchain/tokenlist.mdx (1)

35-37: Phrasing looks good — no issues found.
The deprecation notice is clear, grammatically correct, and correctly references Circle and USDC.

pages/stack/smart-contracts/smart-contracts.mdx (5)

40-41: Verify new internal doc link.
Double-check that /stack/smart-contracts/superchain-ops-guide exists (slug, directory, and extension) — broken internal links generate build warnings.


312-316: Unescaped ampersand may be sufficient.
In Markdown links, & characters normally do not require escaping. The added backslashes (\&) could show up literally in rendered HTML depending on the MDX pipeline. Confirm the rendered link works as intended.


687-688: Same &-escaping concern applies here.
Ensure the utm-parameter link renders correctly and does not include the backslash.


707-708: Explorer domain update LGTM.
The switch to explorer.optimism.io is correct and consistent with the rest of the PR.


731-732: Repeat &-escaping check.
Please verify that the utm_source/utm_medium parameters render without the backslash.

@krofax krofax requested a review from 0xmariniere as a code owner July 17, 2025 16:21
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (2)
pages/stack/transactions/deposit-flow.mdx (2)

108-110: Confirm contract-code deep-link format for Blockscout

Blockscout appends ?tab=code (or similar) rather than #code. The current link may drop readers on the “Overview” tab instead of the source-code view. Please test and adjust.


156-162: Replace “Etherscan” wording & fix section anchors

The headline and copy still reference Etherscan, but the links now point to the Optimism explorer. Recommend renaming accordingly and updating the anchor suffixes (#internaltx, #events) to their Blockscout equivalents (?tab=internal_transactions, ?tab=events).

-**Method A: Using Etherscan Internal Transactions**
+**Method A: Using Optimism explorer internal transactions**

-If you can't see internal transactions on Etherscan, check the
+If internal transactions are not visible on the explorer, check the
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between efa41e4 and 52c5fb7.

📒 Files selected for processing (10)
  • components/TokenListTable.tsx (1 hunks)
  • pages/app-developers/building-apps.mdx (1 hunks)
  • pages/app-developers/tools/build/block-explorers.mdx (1 hunks)
  • pages/app-developers/tools/build/oracles.mdx (1 hunks)
  • pages/app-developers/tutorials/bridging/cross-dom-solidity.mdx (3 hunks)
  • pages/stack/smart-contracts/smart-contracts.mdx (5 hunks)
  • pages/stack/transactions/deposit-flow.mdx (3 hunks)
  • pages/superchain/networks.mdx (2 hunks)
  • pages/superchain/privileged-roles.mdx (2 hunks)
  • utils/networks.ts (2 hunks)
✅ Files skipped from review due to trivial changes (7)
  • pages/app-developers/tools/build/block-explorers.mdx
  • components/TokenListTable.tsx
  • pages/app-developers/building-apps.mdx
  • pages/app-developers/tutorials/bridging/cross-dom-solidity.mdx
  • pages/app-developers/tools/build/oracles.mdx
  • pages/superchain/privileged-roles.mdx
  • pages/stack/smart-contracts/smart-contracts.mdx
🚧 Files skipped from review as they are similar to previous changes (2)
  • utils/networks.ts
  • pages/superchain/networks.mdx
🧰 Additional context used
📓 Path-based instructions (1)
**/*.mdx

Instructions used from:

Sources:
⚙️ CodeRabbit Configuration File

🧠 Learnings (2)
📓 Common learnings
Learnt from: qbzzt
PR: ethereum-optimism/docs#1216
File: pages/stack/interop/security.mdx:136-144
Timestamp: 2025-01-08T11:04:45.361Z
Learning: In the ethereum-optimism/docs repository, sections that are commented out in documentation files are intentionally excluded due to accuracy concerns and should not be suggested for inclusion until the information becomes accurate.
Learnt from: sbvegan
PR: ethereum-optimism/docs#1001
File: pages/builders.mdx:11-12
Timestamp: 2024-10-22T02:58:02.175Z
Learning: Prefer using 'OP Stack' over 'OP Mainnet' in documentation for consistency.
Learnt from: qbzzt
PR: ethereum-optimism/docs#1613
File: public/tutorials/attest.mjs:64-71
Timestamp: 2025-05-24T18:24:46.628Z
Learning: For tutorial and educational code in the ethereum-optimism/docs repository, prioritize simplicity and clarity over production-level robustness. Hardcoded values and simplified error handling are acceptable when they help demonstrate core concepts without unnecessary complexity.
Learnt from: qbzzt
PR: ethereum-optimism/docs#1390
File: public/tutorials/CustomSuperchainToken.sol:32-38
Timestamp: 2025-02-20T16:55:42.917Z
Learning: In tutorial and example code for the ethereum-optimism/docs repository, prioritize code clarity and simplicity over additional security measures or optimizations, unless they are specifically part of the learning objectives.
Learnt from: qbzzt
PR: ethereum-optimism/docs#1577
File: pages/interop/tutorials/upgrade-to-superchain-erc20/contract-upgrade.mdx:175-175
Timestamp: 2025-06-09T01:32:37.738Z
Learning: In Optimism documentation, code snippets can reference embedded code within shell scripts using line number ranges. For example, `file=<rootDir>/public/tutorials/setup-for-erc20-upgrade.sh#L26-L66` can correctly extract Solidity code that's embedded within a shell script, with the language identifier determining syntax highlighting regardless of the source file extension.
pages/stack/transactions/deposit-flow.mdx (3)
Learnt from: qbzzt
PR: ethereum-optimism/docs#1216
File: pages/stack/interop/security.mdx:136-144
Timestamp: 2025-01-08T11:04:45.361Z
Learning: In the ethereum-optimism/docs repository, sections that are commented out in documentation files are intentionally excluded due to accuracy concerns and should not be suggested for inclusion until the information becomes accurate.
Learnt from: sbvegan
PR: ethereum-optimism/docs#1001
File: pages/builders.mdx:11-12
Timestamp: 2024-10-22T02:58:02.175Z
Learning: Prefer using 'OP Stack' over 'OP Mainnet' in documentation for consistency.
Learnt from: qbzzt
PR: ethereum-optimism/docs#1613
File: public/tutorials/attest.mjs:64-71
Timestamp: 2025-05-24T18:24:46.628Z
Learning: For tutorial and educational code in the ethereum-optimism/docs repository, prioritize simplicity and clarity over production-level robustness. Hardcoded values and simplified error handling are acceptable when they help demonstrate core concepts without unnecessary complexity.
⏰ 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 (2)
pages/stack/transactions/deposit-flow.mdx (2)

48-50: Verify that the new explorer anchor still resolves correctly

testnet-explorer.optimism.io is Blockscout-based and does not expose the #address anchor style used by Etherscan. Hitting the URL with #address/… currently returns a 404. Double-check the exact path structure (likely /address/<addr>) and update the link accordingly to avoid breaking docs.


1-22: Front-matter looks complete

All required metadata fields are present and non-empty for a regular page. No action needed.

@krofax krofax merged commit 4c1c33d into main Jul 18, 2025
12 checks passed
@krofax krofax deleted the update-explorer branch July 18, 2025 13:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants