docs icon indicating copy to clipboard operation
docs copied to clipboard

Smart contract section

Open bradleycamacho opened this issue 7 months ago • 4 comments

Creates a new section on docs relating to smart contracts

bradleycamacho avatar Apr 10 '25 18:04 bradleycamacho

Deploy Preview for docs-optimism ready!

Name Link
Latest commit 2521d60b58a75b44fc2fe01ccbe08c4aa165dde4
Latest deploy log https://app.netlify.com/projects/docs-optimism/deploys/6839f7e0985e8c00085d12a2
Deploy Preview https://deploy-preview-1563--docs-optimism.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

netlify[bot] avatar Apr 10 '25 18:04 netlify[bot]

[!WARNING]

Rate limit exceeded

@bradleycamacho has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 16 minutes and 50 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

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.

📥 Commits

Reviewing files that changed from the base of the PR and between 3ffb217ee020ca61dab19b785fd8cb5485f7261c and 2521d60b58a75b44fc2fe01ccbe08c4aa165dde4.

📒 Files selected for processing (2)
  • pages/stack/_meta.json (1 hunks)
  • pages/stack/smart-contracts/upgrade-op-contracts-1-3-1-8.mdx (1 hunks)
📝 Walkthrough

"""

Walkthrough

This set of changes restructures and expands the OP Stack smart contract documentation. The main updates include splitting the previous single smart contracts documentation into a high-level overview page with navigation cards and a new, detailed guide covering all OP Stack smart contracts, their versions, upgrade processes, and deployment details. Additional guides for upgrading contracts using op-deployer and for migrating from version 1.3.0 to 1.8.0 are introduced. Numerous internal links are updated to reflect the new documentation structure. Metadata and redirect rules are also added or modified to support the new organization.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant DocsSite
    participant Redirects
    participant SmartContractsOverview
    participant DetailedGuide
    participant UpgradeGuides

    User->>DocsSite: Navigate to /stack/smart-contracts
    DocsSite->>Redirects: Check for redirect
    Redirects-->>DocsSite: Redirect to /stack/smart-contracts/smart-contracts
    DocsSite->>SmartContractsOverview: Render navigation cards
    User->>SmartContractsOverview: Clicks on a card
    SmartContractsOverview->>DetailedGuide: If "Smart Contracts" selected
    SmartContractsOverview->>UpgradeGuides: If upgrade guide selected
    DetailedGuide-->>User: Show detailed contract info
    UpgradeGuides-->>User: Show upgrade instructions

Possibly related PRs

  • ethereum-optimism/docs#1017: Updates smart-contracts.mdx to fix a typo and clarify versioning details, directly modifying the same documentation files and topics.
  • ethereum-optimism/docs#808: Introduces and restructures the smart contract overview and metadata entries, closely related to the reorganization in this PR.
  • ethereum-optimism/docs#1444: Adds detailed changelog content for smart contract versions, related to the removal of detailed changelogs in this PR.

Suggested labels

tutorial

Suggested reviewers

  • krofax """

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.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

coderabbitai[bot] avatar Apr 10 '25 18:04 coderabbitai[bot]

This is going to be a pain to review, i'd suggest we have this broken down into 2/3 PR's.

krofax avatar Apr 10 '25 18:04 krofax

This is going to be a pain to review, i'd suggest we have this broken down into 2/3 PR's.

It's just two new short docs, the rest of the changes are just redirects and link fixes

bradleycamacho avatar Apr 10 '25 18:04 bradleycamacho