Remove legacy legacy deployment script from docs #1529
Conversation
✅ Deploy Preview for docs-optimism ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThis pull request removes legacy deployment instructions from two documentation files. In the "smart-contracts.mdx" page, a section describing the legacy method to deploy OP Stack L1 contracts via Foundry is removed, including associated warnings, command instructions, and configuration details. Additionally, the version tag for the "Fault Proof Fixes release" has been updated from Possibly related issues
Possibly related PRs
Suggested labels
Suggested reviewers
🪧 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
🧹 Nitpick comments (2)
pages/operators/chain-operators/deploy/smart-contracts.mdx (2)
1-5: Missing Required Metadata in FrontmatterThe frontmatter is missing several required metadata fields—namely,
topic,personas,categories, andcontent_type. These fields are required for all regular pages according to our documentation guidelines. Please add these fields to ensure the metadata is complete. You can fix this by running:pnpm metadata-batch-cli:dry "pages/operators/chain-operators/deploy/smart-contracts.mdx"
11-14: Revise Legacy Deployment Warning CalloutThe warning callout still states that the page shows the legacy method for smart contract deployment. Since the PR removes legacy deployment instructions, this warning can now be confusing to users. Consider updating or removing the callout so that it accurately reflects the current content.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
pages/operators/chain-operators/deploy/smart-contracts.mdx(1 hunks)pages/operators/chain-operators/tutorials/create-l2-rollup.mdx(0 hunks)
💤 Files with no reviewable changes (1)
- pages/operators/chain-operators/tutorials/create-l2-rollup.mdx
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.mdx`: "ALWAYS review Markdown content THOROUGHLY with the following criteria: - First, check the frontmatter section at the top of the file: 1. For regular pages, ensure AL...
**/*.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. You can fix this by running:Review the changes, then run without :dry to apply them.'pnpm metadata-batch-cli:dry "path/to/this/file.mdx"- 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.
"
pages/operators/chain-operators/deploy/smart-contracts.mdx
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - docs-optimism
- GitHub Check: Header rules - docs-optimism
- GitHub Check: Pages changed - docs-optimism
🔇 Additional comments (1)
pages/operators/chain-operators/deploy/smart-contracts.mdx (1)
43-43: Confirm Updated Version TagThe hyperlink for the Fault Proof Fixes release has been updated to point to
v2.0.0-rc.1. Please verify that this update is intended and that it correctly reflects the current release details.
There was a problem hiding this comment.
Actionable comments posted: 0
🔭 Outside diff range comments (1)
pages/operators/chain-operators/deploy/smart-contracts.mdx (1)
1-5: 🛠️ Refactor suggestionMissing required frontmatter metadata.
The frontmatter currently only includes
title,lang, anddescription. According to the documentation guidelines for regular pages, additional fields such astopic,personas,categories, andcontent_typeare required. Please update the metadata accordingly.--- -title: OP Stack Smart Contract Deployment -lang: en-US -description: Learn how to deploy the OP Stack L1 smart contracts. ---- +title: OP Stack Smart Contract Deployment +lang: en-US +description: Learn how to deploy the OP Stack L1 smart contracts. +topic: Smart Contract Deployment +personas: ["Chain Operator"] +categories: ["Deployment", "Smart Contracts"] +content_type: article +---
🧹 Nitpick comments (2)
pages/operators/chain-operators/deploy/smart-contracts.mdx (2)
11-14: Review callout messaging regarding legacy deployment instructions.The callout currently warns that the page is out of date and shows the legacy deployment method. Since the legacy deployment script has been removed per the PR objective, the warning may now be confusing. Please consider updating or removing this callout to clearly reflect the current recommended practices.
41-44: Clarify and streamline deployment instructions.The instruction spanning lines 41–44 now advises deploying the latest Optimism Governance–approved release using [op-deployer]. To improve clarity and ensure consistency, consider merging the split sentence and refining the phrasing. For example:
- All contracts releases are on git tags with the following format: - `op-contracts/vX.Y.Z`. If you're deploying a new standard chain, you should - deploy the latest Optimism Governance approved release of the L1 smart contracts with [op-deployer](/operators/chain-operators/tools/op-deployer). This will only initially deploy with permissioned dispute games - enabled. + All contract releases follow the format `op-contracts/vX.Y.Z`. If deploying a new standard chain, deploy the latest Optimism Governance–approved release of the L1 smart contracts using [op-deployer](/operators/chain-operators/tools/op-deployer), which initially enables only permissioned dispute games.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
pages/operators/chain-operators/deploy/smart-contracts.mdx(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.mdx`: "ALWAYS review Markdown content THOROUGHLY with the following criteria: - First, check the frontmatter section at the top of the file: 1. For regular pages, ensure AL...
**/*.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. You can fix this by running:Review the changes, then run without :dry to apply them.'pnpm metadata-batch-cli:dry "path/to/this/file.mdx"- 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.
"
pages/operators/chain-operators/deploy/smart-contracts.mdx
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - docs-optimism
- GitHub Check: Header rules - docs-optimism
- GitHub Check: Pages changed - docs-optimism
Description
Remove all instructions in the docs that shows how to use the legacy deployment script.
Tests
Additional context
Metadata