Update bootstrap command docs in op-deployer docs #1368
Conversation
✅ Deploy Preview for docs-optimism ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThe pull request updates several documentation files to enhance guidance on the Sequence Diagram(s)sequenceDiagram
participant U as User
participant CLI as CLI Interface
participant DEP as op-deployer
participant L1 as L1 Network
U->>CLI: Execute "op-deployer bootstrap <command>"
CLI->>DEP: Parse bootstrap command (superchain, implementations, proxy)
alt Bootstrap Superchain
DEP->>L1: Initialize new superchain
else Bootstrap Implementations
DEP->>L1: Deploy implementation contracts
else Bootstrap Proxy
DEP->>L1: Setup proxy configuration
end
L1-->>DEP: Return confirmation
DEP-->>CLI: Display operation result
Possibly related PRs
Suggested labels
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
🧹 Nitpick comments (4)
pages/stack/interop.mdx (1)
38-38: Add icon for consistency with other cards.The new card is missing the
iconattribute that is present in all other cards in this component.- <Card title="Interop reorg awareness" href="/stack/interop/reorg" /> + <Card title="Interop reorg awareness" href="/stack/interop/reorg" icon={<img src="/img/icons/shapes.svg" />} />pages/stack/interop/reorg.mdx (2)
36-37: Add missing comma for better readability.Add a comma after "asset transfer" to improve sentence clarity.
- In a normal asset transfer tokens are burned on the source chain first, then a message is sent to the destination chain. + In a normal asset transfer, tokens are burned on the source chain first, then a message is sent to the destination chain.🧰 Tools
🪛 LanguageTool
[uncategorized] ~36-~36: Possible missing comma found.
Context: ...d) end ``` In a normal asset transfer tokens are burned on the source chain f...(AI_HYDRA_LEO_MISSING_COMMA)
160-160: Add missing comma in time expression.Add a comma after "twelve hours" to improve sentence structure.
- After a timeout of twelve hours all the verifiers will assume that the block that should have been posted is a deposit-only block. + After a timeout of twelve hours, all the verifiers will assume that the block that should have been posted is a deposit-only block.🧰 Tools
🪛 LanguageTool
[uncategorized] ~160-~160: Possible missing comma found.
Context: ...posted. After a timeout of twelve hours all the verifiers will assume that the ...(AI_HYDRA_LEO_MISSING_COMMA)
pages/stack/interop/tutorials/message-passing.mdx (1)
573-574: Fix table column alignment.Remove extra spaces in the table column alignment for consistent formatting.
- | ----------: | -------------------------------------------------------------------------- | + | -----------:| -------------------------------------------------------------------------- |
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (5)
pages/operators/chain-operators/tools/op-deployer.mdx(1 hunks)pages/stack/interop.mdx(1 hunks)pages/stack/interop/reorg.mdx(5 hunks)pages/stack/interop/tutorials/message-passing.mdx(8 hunks)words.txt(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.mdx`: "ALWAYS review Markdown content THOROUGHLY with ...
**/*.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.
"
pages/stack/interop.mdxpages/stack/interop/reorg.mdxpages/stack/interop/tutorials/message-passing.mdxpages/operators/chain-operators/tools/op-deployer.mdx
🪛 LanguageTool
pages/stack/interop/reorg.mdx
[uncategorized] ~36-~36: Possible missing comma found.
Context: ...d) end ``` In a normal asset transfer tokens are burned on the source chain f...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~160-~160: Possible missing comma found.
Context: ...posted. After a timeout of twelve hours all the verifiers will assume that the ...
(AI_HYDRA_LEO_MISSING_COMMA)
words.txt
[duplication] ~341-~341: Možný preklep: zopakovali ste slovo
Context: ... Reown's replayability replayor reposts REQUIREDBLOCKS requiredblocks rollouts Rollups rollups Routescan rpck...
(WORD_REPEAT_RULE)
⏰ Context from checks skipped due to timeout of 90000ms (4)
- GitHub Check: Redirect rules - docs-optimism
- GitHub Check: Header rules - docs-optimism
- GitHub Check: Pages changed - docs-optimism
- GitHub Check: pr-workflow
🔇 Additional comments (2)
pages/operators/chain-operators/tools/op-deployer.mdx (1)
132-152: Well-structured documentation with clear guidance!The new bootstrap section effectively:
- Clarifies the specialized nature of the bootstrap commands
- Provides clear use cases
- Guides users toward the standard
applycommand for regular deploymentswords.txt (1)
341-341: LGTM!The new term "reposts" is correctly added in alphabetical order.
🧰 Tools
🪛 LanguageTool
[duplication] ~341-~341: Možný preklep: zopakovali ste slovo
Context: ... Reown's replayability replayor reposts REQUIREDBLOCKS requiredblocks rollouts Rollups rollups Routescan rpck...(WORD_REPEAT_RULE)
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
pages/operators/chain-operators/tools/op-deployer.mdx (1)
132-132: Add comma for improved readability.Add a comma after "tools" to enhance readability and maintain proper sentence structure.
-The bootstrap commands are specialized tools primarily used for initializing a new superchain on an L1 network that hasn't previously hosted one. +The bootstrap commands are specialized tools, primarily used for initializing a new superchain on an L1 network that hasn't previously hosted one.🧰 Tools
🪛 LanguageTool
[uncategorized] ~132-~132: Possible missing comma found.
Context: ... The bootstrap commands are specialized tools primarily used for initializing a new s...(AI_HYDRA_LEO_MISSING_COMMA)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
pages/operators/chain-operators/tools/op-deployer.mdx(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.mdx`: "ALWAYS review Markdown content THOROUGHLY with ...
**/*.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.
"
pages/operators/chain-operators/tools/op-deployer.mdx
🪛 LanguageTool
pages/operators/chain-operators/tools/op-deployer.mdx
[uncategorized] ~132-~132: Possible missing comma found.
Context: ... The bootstrap commands are specialized tools primarily used for initializing a new s...
(AI_HYDRA_LEO_MISSING_COMMA)
⏰ Context from checks skipped due to timeout of 90000ms (4)
- GitHub Check: Redirect rules - docs-optimism
- GitHub Check: Header rules - docs-optimism
- GitHub Check: Pages changed - docs-optimism
- GitHub Check: pr-workflow
🔇 Additional comments (1)
pages/operators/chain-operators/tools/op-deployer.mdx (1)
130-152: Documentation follows style guidelines.The bootstrap usage section maintains consistent formatting, proper capitalization of technical terms, and clear structure. The use cases are well-defined, and the callout effectively guides users to the appropriate command for standard deployments.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~132-~132: Possible missing comma found.
Context: ... The bootstrap commands are specialized tools primarily used for initializing a new s...(AI_HYDRA_LEO_MISSING_COMMA)
Description
Update bootstrap command docs in op-deployer docs
Overview
Updates the documentation for
op-deployer bootstrapcommands to accurately reflect their specialized use cases and prevent confusion among developers.Background
Through developer feedback and discussions, it became clear that the existing documentation for bootstrap commands was causing confusion. Many developers were attempting to use these commands for standard deployments when they should have been using
apply. This update clarifies the intended usage and steers developers toward the appropriate commands for their needs.Changes
Clarified the primary purpose of bootstrap commands
Listed the correct available commands:
Additional context