Standard configuration #1259
Standard configuration #1259
Conversation
✅ Deploy Preview for docs-optimism ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThis pull request introduces documentation for the standard configuration in the OP Stack ecosystem. The changes include adding a new entry in the Sequence DiagramsequenceDiagram
participant Developer
participant OP-Deployer
participant Superchain Registry
Developer->>OP-Deployer: Request chain deployment
OP-Deployer->>OP-Deployer: Validate standard configuration
OP-Deployer->>Superchain Registry: Register compliant chain
Superchain Registry-->>Developer: Confirm chain registration
Possibly related issues
Possibly related PRs
📜 Recent review detailsConfiguration used: .coderabbit.yaml 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
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
|
📝 WalkthroughWalkthroughThe pull request introduces a comprehensive documentation update for the OP Stack's standard configuration. A new metadata entry is added to Sequence DiagramsequenceDiagram
participant User
participant OP-Deployer
participant Superchain Registry
participant Chain
User->>OP-Deployer: Request chain deployment
OP-Deployer->>Superchain Registry: Validate configuration
Superchain Registry-->>OP-Deployer: Confirm standard compliance
OP-Deployer->>Chain: Deploy with standard configuration
OP-Deployer-->>User: Deployment confirmation
Possibly related issues
Possibly related PRs
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: 4
🧹 Nitpick comments (1)
pages/superchain/standard-configuration.mdx (1)
130-130: Fix inconsistent linksThere are two issues with the links:
- The text "Standard rollup configuration page" links to the blockspace charter, which might confuse readers
- The Blockspace Charter link uses an absolute URL instead of a relative path like other links
-For a detailed list of standard configurations, refer to the [Standard rollup configuration page](/superchain/blockspace-charter). +For a detailed list of standard configurations, refer to the [Blockspace Charter](/superchain/blockspace-charter). -* [Blockspace Charter](https://docs.optimism.io/superchain/blockspace-charter) +* [Blockspace Charter](/superchain/blockspace-charter)Also applies to: 162-162
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
pages/superchain/_meta.json(1 hunks)pages/superchain/standard-configuration.mdx(1 hunks)words.txt(2 hunks)
✅ Files skipped from review due to trivial changes (1)
- pages/superchain/_meta.json
🧰 Additional context used
📓 Path-based instructions (1)
pages/superchain/standard-configuration.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.
"
🔇 Additional comments (1)
words.txt (1)
268-268: LGTM!The additions of "Preconfigured" and "Predeployed" are appropriate and align with the technical terminology used in the OP Stack documentation.
Also applies to: 269-269
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 2
♻️ Duplicate comments (1)
pages/superchain/standard-configuration.mdx (1)
74-75: 🛠️ Refactor suggestionMove misplaced content about native ETH
The information about native ETH as gas token is incorrectly placed under "Reduced Support Overhead". This content belongs in the "Standard features" section.
Move these lines to the "Standard features" section and format them consistently with other items in that section.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
pages/superchain/_meta.json(1 hunks)pages/superchain/standard-configuration.mdx(1 hunks)words.txt(2 hunks)
✅ Files skipped from review due to trivial changes (2)
- pages/superchain/_meta.json
- words.txt
🧰 Additional context used
📓 Path-based instructions (1)
pages/superchain/standard-configuration.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: pr-workflow
- GitHub Check: Redirect rules - docs-optimism
- GitHub Check: Header rules - docs-optimism
- GitHub Check: Pages changed - docs-optimism
🔇 Additional comments (2)
pages/superchain/standard-configuration.mdx (2)
1-5: LGTM! Frontmatter is well-structured.The metadata is complete and correctly formatted.
92-99: Consolidate non-standard configuration examplesThe section lists fewer examples than mentioned in the introduction. Consider adding the missing examples (modified block times, custom bridge implementations) or removing them from the introduction to maintain consistency.
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
| @@ -0,0 +1,134 @@ | |||
| --- | |||
| title: Standard configuration | |||
There was a problem hiding this comment.
What do we think about titling the page, "What makes a chain standard?"
| --- | ||
| title: Standard configuration | ||
| lang: en-US | ||
| description: Learn about the standard configuration, how the OP-Deployer aids standardization, and why adhering to these standards is essential. |
There was a problem hiding this comment.
Learn what makes a chain standard, how op-deployer helps with standardization, and why being standard matters.
| description: Learn about the standard configuration, how the OP-Deployer aids standardization, and why adhering to these standards is essential. | |
| description: Learn what makes a chain standard, how op-deployer helps with standardization, and why being standard matters. |
| # The Standard configuration | ||
|
|
||
| The standard configuration within the OP Stack ensures that chains deployed in the Superchain ecosystem adhere to a consistent set of technical and governance parameters. | ||
| This standardization is critical for interoperability, network integrity, and ease of integration across the Superchain. |
There was a problem hiding this comment.
| This standardization is critical for interoperability, network integrity, and ease of integration across the Superchain. | |
| This standardization is critical for Superchain interoperability, network security, and ease of upgrading your chain. |
| The standard configuration within the OP Stack ensures that chains deployed in the Superchain ecosystem adhere to a consistent set of technical and governance parameters. | ||
| This standardization is critical for interoperability, network integrity, and ease of integration across the Superchain. | ||
|
|
||
| This guide provides an in-depth explanation of what defines a standard configuration, how the OP-Deployer aids standardization, and why adhering to these standards is essential. |
There was a problem hiding this comment.
lets use "op-deployer" naming convention that is used in the monorepo. Lets also add an internal link here to our op-deployer docs
| A standard chain in the OP Stack refers to a rollup that adheres to the following principles: | ||
|
|
||
| 1. **Technical conformance:** | ||
| * Compliance with the OP Stack Specifications, including gas fees, block structure, and other protocol-level parameters. |
There was a problem hiding this comment.
| * Compliance with the OP Stack Specifications, including gas fees, block structure, and other protocol-level parameters. | |
| * Compliance with the consensus parameters, policy parameters, admin roles, and service roles defined in the specifications. |
| * **Non-Conforming Modules:** | ||
| Using modules not officially supported by the OP Stack. |
There was a problem hiding this comment.
| * **Non-Conforming Modules:** | |
| Using modules not officially supported by the OP Stack. |
| * **Compliance verification:** | ||
| Chains listed in the registry are verified for adherence to the standard configuration. |
There was a problem hiding this comment.
| * **Compliance verification:** | |
| Chains listed in the registry are verified for adherence to the standard configuration. | |
| * **Superchain levels:** | |
| Chains listed in the registry are denoted with a [`superchain_level`](https://github.com/ethereum-optimism/superchain-registry/blob/main/docs/glossary.md#superchain-level-and-rollup-stage) which tells you which chains are standard. |
| Chains listed in the registry are verified for adherence to the standard configuration. | ||
|
|
||
| * **Community trust:** | ||
| Being part of the registry signals reliability and alignment with Superchain principles. |
There was a problem hiding this comment.
| Being part of the registry signals reliability and alignment with Superchain principles. | |
| Being part of the registry signals reliability and alignment with Optimism Collective principles. |
| 2. **Use OP-Deployer:** | ||
| Leverage OP-Deployer to ensure your chain aligns with standard configurations. |
There was a problem hiding this comment.
| 2. **Use OP-Deployer:** | |
| Leverage OP-Deployer to ensure your chain aligns with standard configurations. | |
| 2. **Use op-deployer:** | |
| Leverage op-deployer to ensure your chain aligns with standard configurations. |
| Consult the [developer support](https://github.com/ethereum-optimism/developers/discussions) team for clarifications on standardization. | ||
|
|
||
| 4. **Contribute to the ecosystem:** | ||
| Engage with the Superchain community to share feedback and propose improvements. |
There was a problem hiding this comment.
| Engage with the Superchain community to share feedback and propose improvements. | |
| Engage with the [Optimism Collective](https://community.optimism.io/) to share feedback and propose improvements. |
Description
Standard Configuration
Overview
This PR adds comprehensive documentation about standard configuration in the OP Stack ecosystem, addressing a common pain point about what constitutes a "standard" chain configuration.
What's Changed
Added a new section under OP Stack that:
cc: @ZakAyesh @tess (for product/technical review)