adding op-deployer callouts #1016
Conversation
✅ Deploy Preview for docs-optimism ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
WalkthroughThe pull request updates three documentation files: "genesis.mdx", "smart-contracts.mdx", and "rollup.mdx". The first two documents now include a warning callout at the beginning, indicating that the information regarding legacy methods for genesis file creation and smart contract deployment is outdated. Users are advised to refer to the Changes
Possibly related issues
Possibly related PRs
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 (3)
pages/builders/chain-operators/deploy/genesis.mdx (1)
17-18: Consider using more formal language in the documentation.Replace personal pronouns with more formal, directive language:
-The following guide shows you how to generate the L2 genesis file `genesis.json`. This is a JSON -file that represents the L2 genesis. You will provide this file to the +The following guide describes how to generate the L2 genesis file `genesis.json`. This is a JSON +file that represents the L2 genesis. This file must be provided to thepages/builders/chain-operators/deploy/smart-contracts.mdx (2)
11-14: Enhance the warning message clarity.While the warning effectively directs users to the new tool, consider providing more context about the legacy method:
<Callout type="warning"> -This page is out of date and shows the legacy method for smart contract deployment. -For the latest recommended method, use [op-deployer](/builders/chain-operators/tools/op-deployer). +This page describes the manual deployment method, which has been deprecated in favor of automated tooling. +Please use [op-deployer](/builders/chain-operators/tools/op-deployer) for a more reliable and streamlined deployment process. </Callout>
16-16: Replace personal pronouns with imperative form.To maintain consistency in communal documentation, consider revising the following text:
-The following guide shows you how to deploy the OP Stack L1 smart contracts. -The primary development branch is `develop`, however **you should only deploy -official contract releases**. You can visit the see the [smart contract overview](/stack/smart-contracts#official-releases) +This guide describes the deployment process for OP Stack L1 smart contracts. +The primary development branch is `develop`, however **only deploy +official contract releases**. Visit the [smart contract overview](/stack/smart-contracts#official-releases)Also applies to: 17-19
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
📒 Files selected for processing (2)
- pages/builders/chain-operators/deploy/genesis.mdx (1 hunks)
- pages/builders/chain-operators/deploy/smart-contracts.mdx (1 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
pages/builders/chain-operators/deploy/genesis.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 headers, 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).
- Use sentence case for H1, H2, and H3 headers, capitalizing only the first word and any proper nouns.
- For all headers (H1, H2, H3), do not change the capitalization of proper nouns; keep them as they are.
"pages/builders/chain-operators/deploy/smart-contracts.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 headers, 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).
- Use sentence case for H1, H2, and H3 headers, capitalizing only the first word and any proper nouns.
- For all headers (H1, H2, H3), do not change the capitalization of proper nouns; keep them as they are.
"
🔇 Additional comments (1)
pages/builders/chain-operators/deploy/genesis.mdx (1)
11-14: LGTM! The warning callout is well-placed and properly formatted.The callout effectively communicates:
- The current status of the documentation
- A clear alternative solution with a proper link
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (3)
pages/builders/chain-operators/configuration/rollup.mdx (3)
Line range hint
32-38: Consider adding recommended values for offset parameters.The network upgrade offset parameters (Regolith, Canyon, Delta, Ecotone, Fjord) would benefit from having specific recommended values, especially since they're required for Standard Config.
Line range hint
1008-1024: Fix inconsistent formatting in Alt-DA Mode section.The formatting in the Alt-DA Mode section differs from other sections:
- Missing horizontal rule before the first parameter
- Inconsistent spacing after section description
Line range hint
1166-1186: Consider removing deprecated fields section.The deprecated fields section contains parameters that are no longer in use. Consider:
- Moving this information to a separate "Migration Guide" document
- Adding deprecation dates to help users understand when these fields were deprecated
- Providing clear migration paths for each deprecated field
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
📒 Files selected for processing (1)
- pages/builders/chain-operators/configuration/rollup.mdx (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
pages/builders/chain-operators/configuration/rollup.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 headers, 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).
- Use sentence case for H1, H2, and H3 headers, capitalizing only the first word and any proper nouns.
- For all headers (H1, H2, H3), do not change the capitalization of proper nouns; keep them as they are.
"
🔇 Additional comments (2)
pages/builders/chain-operators/configuration/rollup.mdx (2)
Line range hint
1-1186: Overall documentation review looks good.The documentation is well-structured, comprehensive, and provides valuable information for configuring OP Stack rollups. The suggested improvements are minor and focused on enhancing clarity and maintainability.
1007-1008:⚠️ Potential issueFix the broken link in Alt-DA Mode section.
The link to the Alt-DA Mode documentation appears to be broken. The line break in the middle of the URL will cause rendering issues.
-for sustainably low costs. Learn more [here](/stack/beta-features/alt-da-mode). +for sustainably low costs. Learn more [here](/stack/beta-features/alt-da-mode).Likely invalid or redundant comment.
Description
These pages are out of date. As a stop gap, I've added callouts to point users to use the
op-deployertool.