Skip to content

Conversation

cpengilly
Copy link
Contributor

new fjord notice page with updates to node upgrade page

Copy link

netlify bot commented Jun 12, 2024

Deploy Preview for docs-optimism ready!

Name Link
🔨 Latest commit bf42f72
🔍 Latest deploy log https://app.netlify.com/sites/docs-optimism/deploys/6670635000913500080fb893
😎 Deploy Preview https://deploy-preview-739--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.

@cpengilly cpengilly marked this pull request as ready for review June 12, 2024 21:41
@cpengilly cpengilly requested a review from a team as a code owner June 12, 2024 21:41
Copy link
Contributor

coderabbitai bot commented Jun 12, 2024

Warning

Rate limit exceeded

@cpengilly has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 3 minutes and 59 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

Files that changed from the base of the PR and between a82a0cb and bf42f72.

Walkthrough

The recent updates focus on revising the documentation and configuration files to accommodate the Fjord network upgrade. This involves updating network upgrade notices, fee estimation methods, adding support for new compression techniques, and adjusting versioning for protocol releases. Additionally, vocabulary updates and accepted status codes are also modified to align with the latest changes.

Changes

Files Change Summary
pages/.../network-upgrades.mdx Updated references from Ecotone to Fjord, adding details like RIP-7212, Brotli compression, and gas cost changes
pages/.../_meta.json Added "fjord-changes" key-value pair
pages/.../fjord-changes.mdx Documented breaking changes and preparations for Fjord upgrade, including fee calculations and hardfork details
words.txt Added terms like Brotli, enablements, removed terms like Ankr, Mitigations, Pyth, SEPOLIA
lychee.toml Added status code 401 to accepted status codes
pages/.../fault-proofs/mips.mdx Removed the "MIPS Reference Sheet" link
pages/.../releases.mdx Updated OP Mainnet and OP Sepolia release version numbers for op-node and op-geth

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?

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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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 resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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: 2

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: 5

cpengilly and others added 2 commits June 12, 2024 15:39
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: Sebastian Stammler <[email protected]>
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: 2

@cpengilly cpengilly requested a review from sebastianst June 13, 2024 16:50
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: 4

Outside diff range and nitpick comments (1)
pages/builders/node-operators/network-upgrades.mdx (1)

Line range hint 129-150: Simplify the phrase "prior to" for better readability.

- *   `Mainnet Upgrade Notice Period` is to allow mainnet node operators to upgrade the node software on mainnet prior to the activation timestamp.
+ *   `Mainnet Upgrade Notice Period` allows mainnet node operators to upgrade the node software on mainnet before the activation timestamp.

@cpengilly cpengilly requested a review from a team June 13, 2024 16:57
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
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

Outside diff range and nitpick comments (8)
pages/stack/protocol/fault-proofs/mips.mdx (8)

Line range hint 25-25: Consider adding a comma before "i.e." to enhance readability.

- ...dispute game i.e. by a `FaultDisputeGame.sol` contract...
+ ...dispute game, i.e., by a `FaultDisputeGame.sol` contract...

Line range hint 38-38: Consider using a more concise alternative to "in order to."

- ...in order to perform a single MIPS instruction onchain...
+ ...to perform a single MIPS instruction onchain...

- ...In order to execute a MIPS instruction onchain, the...
+ ...To execute a MIPS instruction onchain, the...

- ...in order to execute a single instruction onchain is...
+ ...to execute a single instruction onchain is...

- ...In order to ensure the integrity of the entire address...
+ ...To ensure the integrity of the entire address...

- ...in order to determine the true post state given a pre state...
+ ...to determine the true post state given a pre state...

Also applies to: 51-51, 85-85, 87-87, 169-169


Line range hint 85-85: Remove redundancy in the phrase "The primary reason for this is because."

- ...The primary reason for this is because having to load the entire memory...
+ ...The primary reason for this is that loading the entire memory...

Line range hint 87-87: Consider rephrasing "exactly the same" to a shorter form for conciseness.

- ...This merkle root should be exactly the same as the merkle root stored...
+ ...This merkle root should match the merkle root stored...

Line range hint 119-119: Clarify the use of "the write syscall" and remove the redundant hyphen in "newly-derived."

- ...the target of the write syscall, `handleSyscall` will not call...
+ ...the target of writing, `handleSyscall` will not call...

- ...at the location of the newly-derived `preimageKey`.
+ ...at the location of the newly derived `preimageKey`.

Line range hint 154-154: Consider adding a comma for clarity and rephrase "in order to" for conciseness.

- ...is 32-bytes so at most `readMem` will only read 4-bytes due to the...
+ ...is 32-bytes, so at most `readMem` will only read 4-bytes due to the...

- ...The address is used as the path in order to determine the order for hashing...
+ ...The address is used as the path to determine the order for hashing...

Line range hint 169-169: Correct the compound word "pre state" to "prestate."

- ...to determine the true post state given a pre state and...
+ ...to determine the true post state given a prestate and...

Line range hint 178-178: Adjust the use of "however" to improve sentence structure.

- ...according to the MIPS specification, however other instructions...
+ ...according to the MIPS specification; however, other instructions...

@cpengilly cpengilly requested a review from sbvegan June 14, 2024 21:19
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: 1

cpengilly and others added 2 commits June 14, 2024 14:36
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
@sbvegan sbvegan dismissed sebastianst’s stale review June 17, 2024 16:40

review has been addressed

@sbvegan sbvegan merged commit 4b463a1 into main Jun 17, 2024
@sbvegan sbvegan deleted the fjord-notice branch June 17, 2024 16:40
@coderabbitai coderabbitai bot mentioned this pull request Nov 29, 2024
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.

3 participants