Skip to content

Update fp-changes.mdx #730

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 7, 2024
Merged

Update fp-changes.mdx #730

merged 1 commit into from
Jun 7, 2024

Conversation

OPMattie
Copy link
Contributor

@OPMattie OPMattie commented Jun 7, 2024

Updated viem update instructions

Updating Viem instructions to simply be update to latest (>2.9.0) version

Updated viem update instructions
@OPMattie OPMattie requested a review from a team as a code owner June 7, 2024 21:07
Copy link
Contributor

coderabbitai bot commented Jun 7, 2024

Walkthrough

The update in the fp-changes.mdx file simplifies the instructions for developers regarding the Fault Proof upgrade. It now advises updating to the latest version of the Viem library (version >= 2.9.0) without requiring the replacement of decorators, streamlining the upgrade process.

Changes

File Path Change Summary
pages/.../notices/fp-changes.mdx Updated instructions to recommend using Viem version >= 2.9.0 without replacing decorators.

Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 39807a3 and 35a323a.

Files selected for processing (1)
  • pages/builders/notices/fp-changes.mdx (1 hunks)
Additional context used
Path-based instructions (1)
pages/builders/notices/fp-changes.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. Use bold for prominence instead of all caps or italics.
  • 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).
    "
LanguageTool
pages/builders/notices/fp-changes.mdx

[style] ~21-~21: ‘prior to’ might be wordy. Consider a shorter alternative. (EN_WORDINESS_PREMIUM_PRIOR_TO)
Context: ...thdrawal-flow) again. * Withdrawals prior to the Fault Proofs upgrade must wait a 7-...


[uncategorized] ~45-~45: Possible missing article found. (AI_HYDRA_LEO_MISSING_THE)
Context: ...stead of the L2OutputOracle contract. Most notable change for developers is that w...


[uncategorized] ~46-~46: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...against the rootClaim of some dispute game rather than referencing an output in th...

Additional comments not posted (1)
pages/builders/notices/fp-changes.mdx (1)

77-77: Update to the latest version of Viem (version >= 2.9.0) to ensure compatibility with the new Fault Proof changes.


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

netlify bot commented Jun 7, 2024

Deploy Preview for docs-optimism ready!

Name Link
🔨 Latest commit 35a323a
🔍 Latest deploy log https://app.netlify.com/sites/docs-optimism/deploys/66637688683e1a0008f0eabd
😎 Deploy Preview https://deploy-preview-730--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 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 (3)
pages/builders/notices/fp-changes.mdx (3)

Line range hint 45-45: Consider adding an article before "Most notable change".

- Most notable change for developers is that withdrawals will have to be proven against the `rootClaim` of some dispute game rather than referencing an output in the `L2OutputOracle` contract.
+ The most notable change for developers is that withdrawals will have to be proven against the `rootClaim` of some dispute game rather than referencing an output in the `L2OutputOracle` contract.

Line range hint 46-46: Insert a comma after "dispute game".

- ...against the `rootClaim` of some dispute game rather than referencing an output in the `L2OutputOracle` contract.
+ ...against the `rootClaim` of some dispute game, rather than referencing an output in the `L2OutputOracle` contract.

Line range hint 21-21: Consider using a more concise expression.

- Withdrawals prior to the Fault Proofs upgrade must wait a 7-day challenge period before finalization.
+ Withdrawals before the Fault Proofs upgrade must wait a 7-day challenge period before finalization.

@sbvegan sbvegan merged commit b79b7b3 into main Jun 7, 2024
8 checks passed
@sbvegan sbvegan deleted the OPMattie-patch-1 branch June 7, 2024 22:52
@coderabbitai coderabbitai bot mentioned this pull request Nov 1, 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.

2 participants