Remove devnet configs #1099
Remove devnet configs #1099
Conversation
✅ Deploy Preview for docs-optimism ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
WalkthroughThe pull request updates the documentation for the Interop devnet, indicating that the current devnet has been deprecated. It modifies various parameters for both Interop devnet 0 and Interop devnet 1 to reflect this change, setting values such as "Network Name" and "Chain ID" to "TBA" (To Be Announced). Other fields, including "Explorer," "Public RPC URL," and "Sequencer URL," have also been updated to "TBA," while the "OptimismPortal" field has been set to "TBD" (To Be Determined). Additionally, the Changes
Possibly related PRs
Suggested labels
Suggested reviewers
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: 0
🧹 Outside diff range and nitpick comments (4)
pages/stack/interop/devnet.mdx (4)
18-19: Consider using a Callout component for the deprecation noticeFor consistency and better visibility, consider wrapping the deprecation notice in a Callout component, similar to the warning above it.
-NOTE: The current Interop devnet has been deprecated. This page will be updated once the next Interop devnet is live. +<Callout type="warning"> +The current Interop devnet has been deprecated. This page will be updated once the next Interop devnet is live. +</Callout>
24-30: Maintain consistent quote style in the tableSome values use backticks (`) while others use single quotes ('). For consistency, use backticks throughout the table.
| Network Name | `TBA` | | Chain ID | `TBA` | | Currency Symbol<sup>1</sup> | ETH | -| Explorer | 'TBA' | -| Public RPC URL | 'TBA' | -| Sequencer URL | 'TBA' | +| Explorer | `TBA` | +| Public RPC URL | `TBA` | +| Sequencer URL | `TBA` | | OptimismPortal<sup>2</sup> | `TBD` |🧰 Tools
🪛 GitHub Check: lint
[warning] 24-24:
Cell should be padded with 1 space, not 96
[warning] 25-25:
Cell should be padded with 1 space, not 96
[warning] 27-27:
Cell should be padded with 1 space, not 96
[warning] 28-28:
Cell should be padded with 1 space, not 96
[warning] 29-29:
Cell should be padded with 1 space, not 96
[warning] 30-30:
Cell should be padded with 1 space, not 96
36-42: Maintain consistent quote style in the tableSimilar to Devnet 0, ensure consistent use of backticks for values.
| Network Name | `TBA` | | Chain ID | `TBA` | | Currency Symbol<sup>1</sup> | ETH | -| Explorer | 'TBA' | -| Public RPC URL | 'TBA' | -| Sequencer URL | 'TBA' | +| Explorer | `TBA` | +| Public RPC URL | `TBA` | +| Sequencer URL | `TBA` | | OptimismPortal<sup>2</sup> | `TBD` |🧰 Tools
🪛 GitHub Check: lint
[warning] 36-36:
Cell should be padded with 1 space, not 96
[warning] 37-37:
Cell should be padded with 1 space, not 96
22-42: Fix table cell paddingThe markdown tables have excessive padding (96 spaces) in cells. According to the linter, cells should be padded with 1 space.
Example format:
| Parameter | Value | | --------- | ----- | | Network Name | `TBA` |🧰 Tools
🪛 GitHub Check: lint
[warning] 22-22:
Cell should be padded with 1 space, not 96
[warning] 24-24:
Cell should be padded with 1 space, not 96
[warning] 25-25:
Cell should be padded with 1 space, not 96
[warning] 27-27:
Cell should be padded with 1 space, not 96
[warning] 28-28:
Cell should be padded with 1 space, not 96
[warning] 29-29:
Cell should be padded with 1 space, not 96
[warning] 30-30:
Cell should be padded with 1 space, not 96
[warning] 34-34:
Cell should be padded with 1 space, not 96
[warning] 36-36:
Cell should be padded with 1 space, not 96
[warning] 37-37:
Cell should be padded with 1 space, not 96
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
📒 Files selected for processing (1)
pages/stack/interop/devnet.mdx(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
pages/stack/interop/devnet.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.
"
🪛 GitHub Check: lint
pages/stack/interop/devnet.mdx
[warning] 22-22:
Cell should be padded with 1 space, not 96
[warning] 24-24:
Cell should be padded with 1 space, not 96
[warning] 25-25:
Cell should be padded with 1 space, not 96
[warning] 27-27:
Cell should be padded with 1 space, not 96
[warning] 28-28:
Cell should be padded with 1 space, not 96
[warning] 29-29:
Cell should be padded with 1 space, not 96
[warning] 30-30:
Cell should be padded with 1 space, not 96
[warning] 34-34:
Cell should be padded with 1 space, not 96
[warning] 36-36:
Cell should be padded with 1 space, not 96
[warning] 37-37:
Cell should be padded with 1 space, not 96
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
📒 Files selected for processing (2)
pages/stack/interop/devnet.mdx(2 hunks)words.txt(7 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- pages/stack/interop/devnet.mdx
🧰 Additional context used
🪛 LanguageTool
words.txt
[duplication] ~154-~154: Möglicher Tippfehler: ein Wort wird wiederholt
Context: ...OREPRICE ignoreprice Immunefi implicity Inator inator INFLUXDBV influxdbv initcode interchain...
(GERMAN_WORD_REPEAT_RULE)
[duplication] ~156-~156: Möglicher Tippfehler: ein Wort wird wiederholt
Context: ...eprice Immunefi implicity Inator inator INFLUXDBV influxdbv initcode interchain IPCDISABLE ipcdisab...
(GERMAN_WORD_REPEAT_RULE)
[duplication] ~160-~160: Möglicher Tippfehler: ein Wort wird wiederholt
Context: ...INFLUXDBV influxdbv initcode interchain IPCDISABLE ipcdisable ipcfile IPCPATH ipcpath IPFS ipfs JALR ...
(GERMAN_WORD_REPEAT_RULE)
🔇 Additional comments (1)
words.txt (1)
Line range hint 1-407: Verify alignment with PR objectives.
The addition of terms like "Devnet" seems to contradict the PR's objective of removing devnet configurations. Please clarify if these terms should be retained in the dictionary despite the deprecation of devnet configs.
✅ Verification successful
Terms in dictionary are still relevant despite devnet deprecation
The terms "Devnet", "devnet", and "devnets" should be retained in the dictionary. While the specific interop devnet instances are being deprecated, the concept and terminology remain relevant for the project as:
- The documentation still references devnets as a development tool (
make devnet-up,make devnet-down) - Devnets continue to be used for testing network upgrades as shown in the node operators documentation
- New devnets are planned, as evidenced by "This page will be updated once the next Interop devnet is live"
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Check for devnet-related terms in documentation
# Expected: No active references to devnet configuration if it's being deprecated
# Search for devnet-related content in documentation
rg -i 'devnet|interop.*net' --type md
Length of output: 39
Script:
#!/bin/bash
# Let's check for devnet-related configurations and code
rg -i "devnet" -A 3 -B 3
# Also check git history for context about devnet removal
git log -p --all-match --grep="devnet" -i
Length of output: 17515
🧰 Tools
🪛 LanguageTool
[duplication] ~150-~150: Möglicher Tippfehler: ein Wort wird wiederholt
Context: ...rpctimeout HOLESKY Holesky holesky IERC IGNOREPRICE ignoreprice Immunefi implicity Inator inator INFLUX...
(GERMAN_WORD_REPEAT_RULE)
[duplication] ~154-~154: Möglicher Tippfehler: ein Wort wird wiederholt
Context: ...OREPRICE ignoreprice Immunefi implicity Inator inator INFLUXDBV influxdbv initcode interchain...
(GERMAN_WORD_REPEAT_RULE)
[duplication] ~156-~156: Möglicher Tippfehler: ein Wort wird wiederholt
Context: ...eprice Immunefi implicity Inator inator INFLUXDBV influxdbv initcode interchain IPCDISABLE ipcdisab...
(GERMAN_WORD_REPEAT_RULE)
[duplication] ~160-~160: Möglicher Tippfehler: ein Wort wird wiederholt
Context: ...INFLUXDBV influxdbv initcode interchain IPCDISABLE ipcdisable ipcfile IPCPATH ipcpath IPFS ipfs JALR ...
(GERMAN_WORD_REPEAT_RULE)
[duplication] ~163-~163: Möglicher Tippfehler: ein Wort wird wiederholt
Context: ...nterchain IPCDISABLE ipcdisable ipcfile IPCPATH ipcpath IPFS ipfs JALR JOURNALREMOTES journalre...
(GERMAN_WORD_REPEAT_RULE)
Devnet MVP has wrapped up. We'll update this page once devnet stable is live.