docs icon indicating copy to clipboard operation
docs copied to clipboard

feat: update to v3.0.0

Open jcstein opened this issue 1 year ago • 4 comments

Overview

Updating nitro version and docs Resolves https://github.com/celestiaorg/docs/issues/1587

Summary by CodeRabbit

  • Documentation
    • Updated deployment addresses and contract versions in the Arbitrum ecosystem documentation.
    • Enhanced configuration options for validating full nodes in the Arbitrum full node guide.
    • Renamed "Ethereum fallback mechanism" to "DA fallback mechanism" in the Arbitrum integration guide for consistency.

jcstein avatar Jun 14 '24 20:06 jcstein

[!WARNING]

Rate limit exceeded

@jcstein has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 47 minutes and 18 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 058fc1e95610153e390ea91750fac45ed3622bc4 and 0d30cfbfe632b0a254c1672743d328722069096e.

Walkthrough

This update introduces several significant changes to the Arbitrum integration documentation. Key updates include new deployment addresses, contract versions, and enhanced configuration options for validating full nodes. Descriptions of fallback mechanisms and contract addresses have been revised, along with an overall restructuring to reflect these changes.

Changes

Files Change Summary
developers/arbitrum-deploy.md Updated deployment addresses, contract versions, and added new contract deployments.
developers/arbitrum-full-node.md Updated version references, added configuration options for validating full nodes.
developers/arbitrum-integration.md Updated semantic descriptions and features, revised links, fallback mechanisms, and data flags.

Sequence Diagram(s)

The changes are primarily documentation and configuration updates, so sequence diagrams are not applicable here.

Assessment against linked issues

Objective (Issue #1587) Addressed Explanation
Update contract addresses
Update links to new version
Change prefix to 0x63
Remove websocket connections for batch poster Needs further review in specific source code
Config changes: remove 'is-poster', 'event-channel-size'; validator optional Needs further review in specific source code
Add configurable fallback to anytrust, other DA, etc.
3.0.0 enables stylus - add on overview page 058fc1e9 No mention of this addition in review summary
Add DA server for celestia-node (WIP by Diego) Pending WIP by other developer
Update deployment portal after new contracts are ready Deployment portal update status is unclear
Chain migration documentation for migrating from Anytrust to Celestia Not found in the current documentation updates

Poem

Amidst the buzz of code's delight,
Changes dance in daylight bright.
Contracts new and nodes refined,
Configs tweaked and docs aligned.
Arbitrum and Celestia in tune,
Sweet harmony in lines that croon.
🌟 🚀 By Rabbit’s pen, the updates cascade,
Into realms where code upgrades parade.


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.

coderabbitai[bot] avatar Jun 14 '24 20:06 coderabbitai[bot]

PR Preview Action v1.4.7 :---: :rocket: Deployed preview to https://celestiaorg.github.io/docs-preview/./pr-1609/ on branch main at 2024-06-21 15:38 UTC

github-actions[bot] avatar Jun 14 '24 20:06 github-actions[bot]

open tasks from #1587 for @Ferret-san to help with 🙏

  • [ ] add da server for celestia-node - WIP by Diego
  • [ ] update deployment portal after new contracts are ready
  • [ ] review contract addresses

jcstein avatar Aug 05 '24 15:08 jcstein

I think I will be closing this to make the nitro docs much more similar to the OP Stack docs cc @Ferret-san to confirm and then can close this

jcstein avatar Aug 20 '24 20:08 jcstein

closing in order to open a new PR.

jcstein avatar Sep 30 '24 20:09 jcstein