Update Rollup Deployment Configuration #795
Conversation
✅ Deploy Preview for docs-optimism ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
WalkthroughThe documentation has been updated to enhance clarity around OP Stack rollup configurations, with a shift in terminology from "Rollup Configuration" to "Rollup Deployment Configuration." This change emphasizes deployment-specific guidelines, introducing detailed subsections for configuration parameters, including default and recommended values. New links to relevant resources improve accessibility, making the document a more comprehensive resource for developers. Changes
Assessment against linked issues
Possibly related issues
Recent review detailsConfiguration used: .coderabbit.yaml Files selected for processing (1)
Additional context usedPath-based instructions (1)
LanguageTool
Additional comments not posted (5)
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 as PR comments)
Additionally, you can add CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
Outside diff range, codebase verification and nitpick comments (15)
pages/builders/chain-operators/configuration/rollup.mdx (15)
9-16: Improve clarity in the introductory section.The introductory section provides useful context. Ensure proper capitalization and grammar for clarity.
- New OP Stack blockchains are currently configured with a deployment + New OP Stack blockchains are configured with a deployment - configuration JSON file inside that is passed into the smart contract + configuration JSON file that is passed into the smart contract
26-29: Clarify the draft status of the standard configuration.The information about the standard configuration being a draft is useful. Ensure the sentence is clear and concise.
- These requirements are currently a draft, pending governance approval. + These requirements are currently in draft status, pending governance approval.
49-52: Ensure clarity and consistency in the notes section.The notes section provides important information. Ensure the language is clear and consistent.
- * **Notes:** + * **Notes:** Ensure the network upgrade (hardfork) is activated.
63-66: Ensure clarity and consistency in the notes section.The notes section provides important information. Ensure the language is clear and consistent.
- * **Notes:** + * **Notes:** Ensure the network upgrade (hardfork) is activated.
77-80: Ensure clarity and consistency in the notes section.The notes section provides important information. Ensure the language is clear and consistent.
- * **Notes:** + * **Notes:** Ensure the network upgrade (hardfork) is activated.
91-94: Ensure clarity and consistency in the notes section.The notes section provides important information. Ensure the language is clear and consistent.
- * **Notes:** + * **Notes:** Ensure the network upgrade (hardfork) is activated.
105-108: Ensure clarity and consistency in the notes section.The notes section provides important information. Ensure the language is clear and consistent.
- * **Notes:** + * **Notes:** Ensure the network upgrade (hardfork) is activated.
119-122: Clarify the experimental status of interoperability.The notes section mentions that interoperability is experimental. Ensure this is clear.
- * **Notes:** Interoperability is still [experimental](https://specs.optimism.io/interop/overview.html). + * **Notes:** Interoperability is still [experimental](https://specs.optimism.io/interop/overview.html).
131-134: Ensure clarity and consistency in the notes section.The notes section provides important information. Ensure the language is clear and consistent.
- * **Notes:** + * **Notes:** Ensure the network upgrade (hardfork) is activated.
149-152: Clarify the role of the L1 ProxyAdmin owner.The notes section provides information about the L1 ProxyAdmin owner. Ensure the language is clear.
- At the moment, this is L1 ProxyAdmin owner is transferred from the Chain + Currently, the L1 ProxyAdmin owner is transferred from the ChainTools
LanguageTool
[style] ~150-~150: For conciseness, consider replacing this expression with an adverb.
Context: ...t be held by Optimism Security Council. At the moment, this is L1 ProxyAdmin owner is transfe...(AT_THE_MOMENT)
180-185: Ensure clarity and consistency in the notes section.The notes section provides important information. Ensure the language is clear and consistent.
- * **Notes:** Must not be `address(0)` - * **Standard Config Requirement:** Implementation contract must the most - up-to-date, governance-approved version of the OP Stack codebase, and, if the - chain has been upgraded in the past, that the previous versions were a standard - release of the codebase. + * **Notes:** Must not be `address(0)`. + * **Standard Config Requirement:** The implementation contract must be the most + up-to-date, governance-approved version of the OP Stack codebase. If the + chain has been upgraded in the past, the previous versions must have been a standard + release of the codebase.
197-202: Ensure clarity and consistency in the notes section.The notes section provides important information. Ensure the language is clear and consistent.
- * **Notes:** Must not be `address(0)` - * **Standard Config Requirement:** Implementation contract must the most - up-to-date, governance-approved version of the OP Stack codebase, and, if the - chain has been upgraded in the past, that the previous versions were a standard - release of the codebase. + * **Notes:** Must not be `address(0)`. + * **Standard Config Requirement:** The implementation contract must be the most + up-to-date, governance-approved version of the OP Stack codebase. If the + chain has been upgraded in the past, the previous versions must have been a standard + release of the codebase.
213-218: Ensure clarity and consistency in the notes section.The notes section provides important information. Ensure the language is clear and consistent.
- * **Notes:** Must not be `address(0)` - * **Standard Config Requirement:** Implementation contract must the most - up-to-date, governance-approved version of the OP Stack codebase, and, if the - chain has been upgraded in the past, that the previous versions were a standard - release of the codebase. + * **Notes:** Must not be `address(0)`. + * **Standard Config Requirement:** The implementation contract must be the most + up-to-date, governance-approved version of the OP Stack codebase. If the + chain has been upgraded in the past, the previous versions must have been a standard + release of the codebase.
229-234: Ensure clarity and consistency in the notes section.The notes section provides important information. Ensure the language is clear and consistent.
- * **Notes:** Must not be `address(0)` - * **Standard Config Requirement:** Implementation contract must the most - up-to-date, governance-approved version of the OP Stack codebase, and, if the - chain has been upgraded in the past, that the previous versions were a standard - release of the codebase. + * **Notes:** Must not be `address(0)`. + * **Standard Config Requirement:** The implementation contract must be the most + up-to-date, governance-approved version of the OP Stack codebase. If the + chain has been upgraded in the past, the previous versions must have been a standard + release of the codebase.
245-250: Ensure clarity and consistency in the notes section.The notes section provides important information. Ensure the language is clear and consistent.
- * **Notes:** Must not be `address(0)` - * **Standard Config Requirement:** Implementation contract must the most - up-to-date, governance-approved version of the OP Stack codebase, and, if the - chain has been upgraded in the past, that the previous versions were a standard - release of the codebase. + * **Notes:** Must not be `address(0)`. + * **Standard Config Requirement:** The implementation contract must be the most + up-to-date, governance-approved version of the OP Stack codebase. If the + chain has been upgraded in the past, the previous versions must have been a standard + release of the codebase.
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 2
Outside diff range, codebase verification and nitpick comments (4)
pages/builders/chain-operators/configuration/rollup.mdx (4)
49-51: Clarify the default value forl2GenesisRegolithTimeOffset.The default value is stated as "nil," but the recommended value is "0x0." This may cause confusion. Consider clarifying the difference.
- * **Default value:** nil + * **Default value:** nil (no activation)
105-107: Clarify the default value forl2GenesisFjordTimeOffset.The default value is stated as "nil," but the recommended value is "0x0." This may cause confusion. Consider clarifying the difference.
- * **Default value:** nil + * **Default value:** nil (no activation)
131-133: Clarify the default value forl1CancunTimeOffset.The default value is stated as "None," but the recommended value is "0x0." This may cause confusion. Consider clarifying the difference.
- * **Default value:** None + * **Default value:** None (no activation)
149-150: Consider replacing "At the moment" with "Currently".For conciseness, consider replacing "At the moment" with "Currently."
- At the moment, this is L1 ProxyAdmin owner is transferred from the Chain + Currently, this is L1 ProxyAdmin owner is transferred from the ChainTools
LanguageTool
[style] ~150-~150: For conciseness, consider replacing this expression with an adverb.
Context: ...t be held by Optimism Security Council. At the moment, this is L1 ProxyAdmin owner is transfe...(AT_THE_MOMENT)
Description
Additional context
This page needs to be continuously updated to improve the chain deployment process
Metadata