Skip to content

Conversation

sbvegan
Copy link
Collaborator

@sbvegan sbvegan commented Apr 14, 2025

Description

Updating the new absolute prestate and op-challenger that must be used for U15. The new op-challenger release hasn't been published yet, so I'm still waiting on that

@sbvegan sbvegan requested a review from a team as a code owner April 14, 2025 22:31
Copy link

netlify bot commented Apr 14, 2025

Deploy Preview for docs-optimism ready!

Name Link
🔨 Latest commit 64062c6
🔍 Latest deploy log https://app.netlify.com/sites/docs-optimism/deploys/67fd8cad05b7440008bfb02e
😎 Deploy Preview https://deploy-preview-1576--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 site configuration.

Copy link
Contributor

coderabbitai bot commented Apr 14, 2025

📝 Walkthrough

Walkthrough

This set of changes updates documentation and a word list across three files. In pages/notices/superchain-withdrawal-pause-test.mdx, the notice now states that the Sepolia Superchain withdrawal pause test was completed on April 14th, 2025, and removes references to a future Mainnet test date. The pages/notices/upgrade-15.mdx file is revised to provide a fixed activation timestamp for the Mainnet Superchain, update the required op-challenger version to v1.4.0, and recommend op-program v1.6.0-2 for permissionless fault proof chains. It also updates the absolute prestate hash, verification commands, and preimage binary filename, and adds a callout informing node operators about the availability of Mainnet node binaries. The words.txt file has the word "Devs" removed from its list. No changes were made to any exported or public code entities.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Documentation
    participant Node Operator

    User->>Documentation: Reads Superchain withdrawal pause test notice
    Documentation-->>User: Informs test completed on Apr 14, 2025

    User->>Documentation: Reads Isthmus upgrade notice
    Documentation-->>User: Provides Mainnet activation timestamp and updated instructions

    Node Operator->>Documentation: Checks upgrade instructions
    Documentation-->>Node Operator: Informs about op-challenger v1.4.0 and op-program v1.6.0-2
    Documentation-->>Node Operator: Displays callout about Mainnet node binaries availability
Loading

Possibly related PRs

Tip

⚡💬 Agentic Chat (Pro Plan, General Availability)
  • We're introducing multi-step agentic chat in review comments and issue comments, within and outside of PR's. This feature enhances review and issue discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments and add commits to existing pull requests.

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.
    • Generate unit testing code for this file.
    • 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 generate unit testing code for this file.
    • @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 generate unit testing code.
    • @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.

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 resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
pages/notices/upgrade-15.mdx (1)

20-143: Minor grammar: Consider pluralizing "prestate" where appropriate.

In several places, "prestate" is used as a plural noun (e.g., "absolute prestates"). The correct plural form should be "prestates." For example, in line 49: "deploy new dispute game contracts with new absolute prestates" and in line 55: "the 64 bit multi-threaded version of cannon is utilized" (contextually, this is fine, but check for consistency).

Consider updating "prestate" to "prestates" where referring to multiple instances for grammatical correctness.

Otherwise, the documentation is clear, uses proper nouns, imperative form, and avoids personal pronouns. Headers follow sentence case and proper noun capitalization. Technical instructions are accurate and up to date.

🧰 Tools
🪛 LanguageTool

[grammar] ~62-~62: The verb ‘prestate’ is plural. Did you mean: “prestates”? Did you use a verb instead of a noun?
Context: ...oneium) You can verify this absolute prestate by running the following [command](http...

(PLURAL_VERB_AFTER_THIS)


[style] ~95-~95: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ...e and validate that the expected output prior to executing the transaction. Th...

(EN_WORDINESS_PREMIUM_PRIOR_TO)


[duplication] ~115-~115: Possible typo: you repeated a word.
Context: ... has been determined. * op-node at v1.13.0 * [op-geth at v1.101503.2](https://github.com/ether...

(ENGLISH_WORD_REPEAT_RULE)


[style] ~133-~133: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...oth op-node and op-geth. These will need to be set on op-node and op-geth for t...

(REP_NEED_TO_VB)

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0f08d4b and 64062c6.

📒 Files selected for processing (3)
  • pages/notices/superchain-withdrawal-pause-test.mdx (1 hunks)
  • pages/notices/upgrade-15.mdx (4 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:
    1. 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]
    ---
    1. 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]
    ---
    1. 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:
    1. Use sentence case, capitalizing only the first word.
    2. 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.
    3. 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/notices/superchain-withdrawal-pause-test.mdx
  • pages/notices/upgrade-15.mdx
🪛 LanguageTool
pages/notices/upgrade-15.mdx

[grammar] ~62-~62: The verb ‘prestate’ is plural. Did you mean: “prestates”? Did you use a verb instead of a noun?
Context: ...oneium) You can verify this absolute prestate by running the following [command](http...

(PLURAL_VERB_AFTER_THIS)

⏰ 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 (3)
pages/notices/upgrade-15.mdx (1)

1-16: Frontmatter is complete and valid.

All required metadata fields are present and non-empty. No action needed.

pages/notices/superchain-withdrawal-pause-test.mdx (2)

1-16: Frontmatter is complete and valid.

All required metadata fields are present and non-empty. No action needed.


23-24: Update is clear and accurate.

The callout correctly reflects the completion of the Sepolia Superchain withdrawal pause test. No issues found.

@sbvegan sbvegan merged commit d5614c9 into main Apr 15, 2025
8 checks passed
@sbvegan sbvegan deleted the sb/u15-new-ap-and-challenger branch April 15, 2025 15:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants