updated the smart contract deployment guide #1585
Conversation
✅ Deploy Preview for docs-optimism ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
Warning Rate limit exceeded@krofax has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 16 minutes and 25 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThe changes update the documentation for deploying OP Stack L1 smart contracts, replacing a legacy deployment guide with a comprehensive, step-by-step workflow centered around the Sequence Diagram(s)sequenceDiagram
participant User
participant op-deployer
participant L1 Network
participant Block Explorer
participant L2 Node
User->>op-deployer: Install op-deployer
User->>op-deployer: Create & customize intent file
User->>op-deployer: Execute deployment command
op-deployer->>L1 Network: Deploy contracts
User->>Block Explorer: (Optional) Verify contracts
op-deployer->>User: Generate L2 config files
User->>L2 Node: Provide config files
Possibly related PRs
Suggested reviewers
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 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: 1
🧹 Nitpick comments (6)
pages/operators/chain-operators/deploy/smart-contracts.mdx (6)
32-34: Improve link text and grammar in warning callout
- Link text should use title case for page names: change
[smart contract overview]to[Smart Contract Overview].- Use “backward compatible” instead of “backwards compatible” for standard technical phrasing.
Apply this diff:- Always deploy from official contract releases. You can find official release versions in the - [smart contract overview](/stack/smart-contracts#official-releases). Contract changes are - generally not considered backwards compatible. + Always deploy from official contract releases. You can find official release versions in the + [Smart Contract Overview](/stack/smart-contracts#official-releases). Contract changes are + generally not considered backward compatible.
56-56: Consistent title case for link to configuration guide
Link text should be in title case for page names. Consider:- See the [op-deployer configuration guide](/operators/chain-operators/tools/op-deployer#understanding-the-intenttoml-fields) for details. + See the [Op-Deployer Configuration Guide](/operators/chain-operators/tools/op-deployer#understanding-the-intenttoml-fields) for details.
66-66: Use sentence case for optional tag in step heading
Per header style, only the first word and proper nouns are capitalized. Update:- ### Verify contract source code (Optional) + ### Verify contract source code (optional)
105-107: Use sentence case in version compatibility list items
Ensure only the first word and proper nouns are capitalized. Update:- * L2 Client compatibility: Ensure your chosen contract version is compatible with the op-geth and op-node versions you plan to use + * L2 client compatibility: Ensure your chosen contract version is compatible with the op-geth and op-node versions you plan to use - * Security Updates: Always prefer the latest patch version within your chosen major.minor version + * Security updates: Always prefer the latest patch version within your chosen major.minor version
109-109: Use sentence case for 'Next steps' header
H2 headers should capitalize only the first word and proper nouns. Update:- ## Next Steps + ## Next steps
111-113: Title case for next-step links
Link texts that reference pages should be in title case:- * Learn how to [create your genesis file](/operators/chain-operators/deploy/genesis). + * Learn how to [Create Your Genesis File](/operators/chain-operators/deploy/genesis). - * See all [configuration options](/operators/chain-operators/configuration/rollup) and example configurations. + * See all [Configuration Options](/operators/chain-operators/configuration/rollup) and example configurations.
📜 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)words.txt(0 hunks)
💤 Files with no reviewable changes (1)
- words.txt
🧰 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. Please check keywords.config.yaml for valid options and add the required fields manually. You can validate your changes by running:pnpm validate-metadata ```'- 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)
25-29: Approve introduction and overview sections
The new guide introduction and overview header are clear, descriptive, and comply with sentence-case and style guidelines.
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
pages/operators/chain-operators/deploy/smart-contracts.mdx (3)
33-33: Use title case for page link text
The link text "[smart contract overview]" should follow title case for page names. Change it to "[Smart Contract Overview]" to align with documentation conventions.
66-66: Lowercase parenthetical "optional" in headers
For sentence-case headers, only the first word is capitalized. Update "(Optional)" to "(optional)" in "Verify contract source code (Optional)".
109-109: Use sentence case for section headers
The header "## Next Steps" should be sentence case—only the first word capitalized. Change it to "## Next steps".
📜 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. Please check keywords.config.yaml for valid options and add the required fields manually. You can validate your changes by running:pnpm validate-metadata ```'- 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
This PR updates the "OP Stack Smart Contract Deployment" documentation to reflect current best practices using op-deployer, addressing the outdated content in the existing guide.
Changes
Tests
Additional context
Metadata