adding address details for opcm #1028
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for docs-optimism ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
WalkthroughThe pull request updates the document Changes
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 (2)
pages/stack/opcm.mdx (2)
14-15: Enhance clarity and provide more contextConsider restructuring the sentence for better readability and adding more context about the releases:
-The version deployed is always a governance-approved contract release. The set of governance approved contract releases can be found on the Optimism Monorepo releases page, and is the set of releases named `op-contracts/vX.Y.Z`. It deploys the [Fault Proof System](/stack/fault-proofs/explainer), using the [PermissionedDisputeGame](/stack/smart-contracts#permissioneddisputegame). +The OP Contracts Manager deploys only governance-approved contract releases. These releases are available on the Optimism Monorepo releases page under the naming convention `op-contracts/vX.Y.Z`. The deployment includes the [Fault Proof System](/stack/fault-proofs/explainer) implementation, which utilizes the [PermissionedDisputeGame](/stack/smart-contracts#permissioneddisputegame) for dispute resolution.
16-17: Improve address presentation formatConsider enhancing the address presentation for better readability:
-* Ethereum address: [0x18cec91779995ad14c880e4095456b9147160790](https://etherscan.io/address/0x18cec91779995ad14c880e4095456b9147160790) -* Sepolia address: [0xf564eea7960ea244bfebcbbb17858748606147bf](https://sepolia.etherscan.io/address/0xf564eea7960ea244bfebcbbb17858748606147bf) +## Contract addresses + +| Network | Address | +|---------|---------| +| Ethereum Mainnet | [`0x18cec91779995ad14c880e4095456b9147160790`](https://etherscan.io/address/0x18cec91779995ad14c880e4095456b9147160790) | +| Sepolia Testnet | [`0xf564eea7960ea244bfebcbbb17858748606147bf`](https://sepolia.etherscan.io/address/0xf564eea7960ea244bfebcbbb17858748606147bf) |This table format:
- Provides better visual organization
- Clearly distinguishes between networks
- Makes addresses more readable with proper formatting
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
📒 Files selected for processing (1)
- pages/stack/opcm.mdx (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
pages/stack/opcm.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/stack/opcm.mdx (1)
14-17: Changes align with documentation objectivesThe additions effectively enhance the documentation by:
- Clarifying the deployment process and relationship with the Fault Proof System
- Providing essential contract addresses for both mainnet and testnet environments
The changes maintain consistency with the existing documentation structure and provide valuable information for users.
cpengilly
approved these changes
Oct 25, 2024
This was referenced Oct 28, 2024
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description