Remove devnet information #1670
Conversation
Remove stable devnet info
✅ Deploy Preview for docs-optimism ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
📝 WalkthroughWalkthroughThe documentation for the Superchain interop devnet was updated to reflect its deprecation. All specific details about Interop devnet networks, such as network names, chain IDs, block explorers, RPC URLs, sequencer URLs, contract addresses, and bridging instructions, were removed or left blank. Sections related to block explorers and the Superchain interop transaction relayer were also deleted. Instructions for obtaining testnet ETH and bridging were simplified to remove references to deprecated devnets. The remainder of the page, including warnings and next steps, was left unchanged. Additionally, the entire "Release candidate - Alpha" devnet documentation page and its metadata entry were removed, further consolidating the deprecation of older devnet environments. Possibly related PRs
Suggested reviewers
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed 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)
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: 1
🧹 Nitpick comments (1)
pages/interop/tools/devnet.mdx (1)
25-27: Avoid all-caps emphasis in callouts
TheNOTE:label is in all caps, which violates the style guideline (“Avoid using all caps for emphasis”). Rephrase or drop the label:-<Callout> - NOTE: The current Interop devnet has been deprecated. This page will be updated once the next Interop devnet is live. -</Callout> +<Callout> + The current Interop devnet is deprecated. This page will be updated once the next Interop devnet is live. +</Callout>
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
pages/interop/tools/devnet.mdx(4 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.mdx`: "ALWAYS review Markdown content THOROUGHLY with the following criter...
**/*.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.
"
⚙️ Source: CodeRabbit Configuration File
List of files the instruction was applied to:
pages/interop/tools/devnet.mdx
🪛 LanguageTool
pages/interop/tools/devnet.mdx
[uncategorized] ~79-~79: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...directly to the OptimismPortal address and it will go to the same sender address o...
(COMMA_COMPOUND_SENTENCE)
⏰ 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/interop/tools/devnet.mdx (2)
1-19: Front-matter looks complete
All required metadata fields are present and non-empty.
79-79: Comma missing in compound sentence & link may be staleLanguageTool correctly flags a missing comma. Apply:
- You can send `ETH` directly to the `OptimismPortal` address and it will go to the same sender address on the devnet. Alternatively, you can use this [bridge front end](https://interop-devnet.superbridge.app/) to bridge `ETH` from Sepolia. + You can send `ETH` directly to the `OptimismPortal` address, and it will go to the same sender address on the devnet. Alternatively, you can use this [bridge front-end](https://interop-devnet.superbridge.app/) to bridge `ETH` from Sepolia.Also, confirm the referenced front-end is still live; if the devnet is deprecated, the link may 404.
…ormatting issues in devnet.mdx.
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (1)
pages/interop/tools/devnet.mdx (1)
37-45: Empty cells still present – replace with “Deprecated / N-A” or drop tablesBlank cells can mislead readers into thinking information is missing rather than intentionally removed.
Either delete the two parameter tables entirely or fill every empty cell with a clear indicator such as “Deprecated” or “N/A”.This was raised in an earlier review and remains unresolved.
Also applies to: 49-57
🧹 Nitpick comments (4)
pages/interop/tools/devnet.mdx (4)
25-27: Remove redundant “NOTE:” prefix and tighten wordingThe
<Callout>component already conveys emphasis, so the “NOTE:” prefix is unnecessary.
Consider rewriting in the imperative to stay consistent with style guidelines (avoid personal pronouns).-<Callout> - NOTE: The current Interop devnet has been deprecated. This page will be updated once the next Interop devnet is live. -</Callout> +<Callout> + The current Interop devnet is deprecated. This page will be updated when the next Interop devnet is live. +</Callout>
67-67: Use imperative voice; avoid “you can utilize”Style guide prefers imperative and plain verbs.
- You can utilize the [Superchain Faucet](https://console.optimism.io/faucet?utm_source=op-docs\&utm_medium=docs) to get `ETH`. + Use the [Superchain Faucet](https://console.optimism.io/faucet?utm_source=op-docs&utm_medium=docs) to obtain `ETH`.
75-75: Same phrasing issue as line 67- You can utilize the [Superchain Faucet](https://console.optimism.io/faucet?utm_source=op-docs\&utm_medium=docs) to get `ETH` on Sepolia. + Use the [Superchain Faucet](https://console.optimism.io/faucet?utm_source=op-docs&utm_medium=docs) to obtain `ETH` on Sepolia.
79-79: Comma splice and imperative toneInsert a comma before “and” to join two independent clauses, and switch to imperative style.
- You can send `ETH` directly to the `OptimismPortal` address and it will go to the same sender address on the devnet. Alternatively, you can use this [bridge front end](https://interop-devnet.superbridge.app/) to bridge `ETH` from Sepolia. + Send `ETH` directly to the `OptimismPortal` address, and it will be credited to the same sender address on the devnet. Alternatively, use this [bridge front-end](https://interop-devnet.superbridge.app/) to bridge `ETH` from Sepolia.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
pages/interop/tools.mdx(0 hunks)pages/interop/tools/devnet.mdx(3 hunks)
💤 Files with no reviewable changes (1)
- pages/interop/tools.mdx
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.mdx`: "ALWAYS review Markdown content THOROUGHLY with the following criter...
**/*.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.
"
⚙️ Source: CodeRabbit Configuration File
List of files the instruction was applied to:
pages/interop/tools/devnet.mdx
🪛 LanguageTool
pages/interop/tools/devnet.mdx
[uncategorized] ~79-~79: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...directly to the OptimismPortal address and it will go to the same sender address o...
(COMMA_COMPOUND_SENTENCE)
⏰ 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
Fixed the issue and approved PR. |
Thanks! @fainashalts can you assist |
Remove stable devnet info