chore: update preinstalls #1303
Conversation
✅ Deploy Preview for docs-optimism ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThe pull request modifies the documentation for preinstalled contracts in the Optimism ecosystem. The changes involve removing several existing contracts like Possibly related issues
Possibly related PRs
Suggested reviewers
Warning Review ran into problems🔥 ProblemsGit: Failed to clone repository. Please run the 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 comments (1)
pages/builders/chain-operators/features/preinstalls.mdx (1)
Line range hint
8-13: Improve documentation style and consistency.Please revise the introductory paragraphs to align with our documentation guidelines:
- Replace personal pronouns with proper nouns
- Ensure consistent capitalization of technical terms
- Use the Oxford comma consistently
Apply these changes:
-To go to production on a new chain, developers need their core contracts: Gnosis Safes, the 4337 entrypoint, create2deployer, etc. On a blank EVM, these contracts can take weeks to be deployed. Now, core contracts come *preinstalled* on the OP Stack -- no third party deployment necessary. -Whether hacking alone or starting the next big rollup, developers can start using their favorite contracts as soon as they spin up their chain. +To go to production on a new chain, the system requires core contracts: Gnosis Safe, the ERC-4337 EntryPoint, Create2Deployer, and other essential contracts. On a blank EVM, contract deployment can take weeks. The OP Stack provides these core contracts preinstalled, eliminating the need for third-party deployment. +The preinstalled contracts are available immediately upon chain initialization, enabling rapid development and deployment.
🧹 Nitpick comments (1)
pages/builders/chain-operators/features/preinstalls.mdx (1)
43-43: Update the resources section formatting.The resources section needs formatting adjustments to align with our documentation guidelines:
- Remove italics used for emphasis
- Use proper title case for the link text
Apply this change:
-* Still Have Questions? You can reach us in our [developer support forum](https://github.com/ethereum-optimism/developers/discussions). +* Still have questions? Visit the [Developer Support Forum](https://github.com/ethereum-optimism/developers/discussions).
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
pages/builders/chain-operators/features/preinstalls.mdx(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
pages/builders/chain-operators/features/preinstalls.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 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.
"
⏰ 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/builders/chain-operators/features/preinstalls.mdx (1)
33-41: LGTM! The contract table updates are accurate and well-formatted.The updated table entries maintain consistency in formatting while providing accurate contract references and addresses.
Preinstall docs were out of date, h/t @pcaversaccio for flagging