Skip to content

docs[wip]: start cleaning up nitro/op #1900

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 4 commits into from
Mar 27, 2025
Merged

docs[wip]: start cleaning up nitro/op #1900

merged 4 commits into from
Mar 27, 2025

Conversation

jcstein
Copy link
Member

@jcstein jcstein commented Feb 20, 2025

Overview

Summary by CodeRabbit

  • New Features

    • Introduced a comprehensive guide for local development on the Nitro stack.
  • Documentation

    • Updated sidebar navigation by replacing outdated items and adding new links, including one to the Gelato dashboard.
    • Removed several guides covering asset bridging, rollup deployment, and legacy testnet references.
    • Refined guide content with improved navigation pointers and streamlined prerequisites for better clarity.

Copy link
Contributor

coderabbitai bot commented Feb 20, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

This pull request updates the documentation navigation and guides. The sidebar configuration in the VitePress config file is modified to adjust regex patterns and update navigational links. Multiple guide files have been removed while others have their content and metadata updated to reflect shifts in focus, terminology, and linking. A new guide for local development on the Nitro stack has been introduced alongside minor formatting and link updates in several existing guides.

Changes

File(s) Change Summary
.vitepress/config.ts Updated regex patterns in transformHead; modified sidebar navigation items by replacing, removing, and adding links (e.g., "Quickstart: Local development with Nitro testnode", removal of "Bridging in and out...", addition of "Gelato").
how-to-guides/arbitrum-bridge.md, how-to-guides/arbitrum-deploy.md, how-to-guides/bubs-testnet.md, how-to-guides/optimism-devnet.md Deleted comprehensive guides covering bridging, deployment, Bubs testnet, and Optimism devnet instructions.
how-to-guides/arbitrum-full-node.md, how-to-guides/arbitrum-integration.md, how-to-guides/ethereum-fallback.md, how-to-guides/intro-to-op-stack.md, how-to-guides/optimism.md, how-to-guides/rollup-stacks.md Updated guide metadata and content: added new navigation entries (e.g., next links), revised text and link references, reformatted technical terms, and removed outdated components (e.g., Bubs testnet button).
how-to-guides/nitro-local.md New guide added for local development on the Arbitrum Nitro stack, including instructions for Docker setup, test node initialization, and optional configuration commands.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Sidebar
    participant Docs
    User->>Sidebar: Selects a sidebar item (e.g., "Gelato" or "Nitro testnode")
    Sidebar->>Docs: Loads the linked documentation
    Docs-->>User: Displays updated guide content
Loading

Possibly related issues

  • docs: arbitrum updates #1488: Sidebar updates and removal of Bubs testnet references align with the documentation restructuring outlined in this issue.

Possibly related PRs

Suggested labels

documentation

Suggested reviewers

  • Ferret-san

Poem

I'm a hopping coder, a rabbit on a spree,
Tweaking docs and sidebars so meticulously.
Old guides vanish like carrots in the wind,
New paths and links make my heart grin.
With every hop, a cleaner doc field appears—
Celebrating each change with bouncy cheers!
🐰✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4ca5e93 and f98aaaa.

⛔ Files ignored due to path filters (24)
  • public/arbitrum/add-custom-chain-to-bridge.png is excluded by !**/*.png
  • public/arbitrum/blockscout.png is excluded by !**/*.png
  • public/arbitrum/bridge-in-explorer-rollup-tx.png is excluded by !**/*.png
  • public/arbitrum/bridge-in-pending-txs.png is excluded by !**/*.png
  • public/arbitrum/bridge-in-sepolia-tx-explorer.png is excluded by !**/*.png
  • public/arbitrum/bridge-in-settled-txs.png is excluded by !**/*.png
  • public/arbitrum/bridge-in-start.png is excluded by !**/*.png
  • public/arbitrum/bridge-in-success.png is excluded by !**/*.png
  • public/arbitrum/bridge-out-begin-overview.png is excluded by !**/*.png
  • public/arbitrum/bridge-out-begin.png is excluded by !**/*.png
  • public/arbitrum/bridge-out-claim-success-withdrawal.png is excluded by !**/*.png
  • public/arbitrum/bridge-out-claim-withdrawal.png is excluded by !**/*.png
  • public/arbitrum/bridge-out-logs-details-1.png is excluded by !**/*.png
  • public/arbitrum/bridge-out-logs-explorer-2.png is excluded by !**/*.png
  • public/arbitrum/bridge-out-pending.png is excluded by !**/*.png
  • public/arbitrum/bridge-out-rollup-tx-details.png is excluded by !**/*.png
  • public/arbitrum/bridge-out-small-screenshot.png is excluded by !**/*.png
  • public/arbitrum/bridge-overview-deposit-and-withdrawal-l3.png is excluded by !**/*.png
  • public/arbitrum/bridge-settings.png is excluded by !**/*.png
  • public/arbitrum/choose_da.png is excluded by !**/*.png
  • public/arbitrum/configuration.png is excluded by !**/*.png
  • public/arbitrum/download-config.png is excluded by !**/*.png
  • public/arbitrum/explorer-view.png is excluded by !**/*.png
  • public/arbitrum/live-orbit-chains.png is excluded by !**/*.png
📒 Files selected for processing (12)
  • .vitepress/config.ts (4 hunks)
  • how-to-guides/arbitrum-bridge.md (0 hunks)
  • how-to-guides/arbitrum-deploy.md (0 hunks)
  • how-to-guides/arbitrum-full-node.md (2 hunks)
  • how-to-guides/arbitrum-integration.md (3 hunks)
  • how-to-guides/bubs-testnet.md (0 hunks)
  • how-to-guides/ethereum-fallback.md (1 hunks)
  • how-to-guides/intro-to-op-stack.md (2 hunks)
  • how-to-guides/nitro-local.md (1 hunks)
  • how-to-guides/optimism-devnet.md (0 hunks)
  • how-to-guides/optimism.md (1 hunks)
  • how-to-guides/rollup-stacks.md (0 hunks)
✨ Finishing Touches
  • 📝 Generate Docstrings

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.

CodeRabbit Configuration 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.

@jcstein jcstein self-assigned this Feb 20, 2025
Copy link
Contributor

github-actions bot commented Feb 20, 2025

PR Preview Action v1.6.0

🚀 View preview at
https://celestiaorg.github.io/docs-preview/pr-1900/

Built to branch main at 2025-03-27 17:59 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

@jcstein
Copy link
Member Author

jcstein commented Feb 24, 2025

@jcstein jcstein requested a review from Ferret-san March 18, 2025 13:52
@jcstein
Copy link
Member Author

jcstein commented Mar 21, 2025

let's try and get these TODOs that are added in this PR done and get it across the line @Ferret-san

@jcstein jcstein marked this pull request as ready for review March 27, 2025 18:05
@jcstein jcstein merged commit 6eadf34 into main Mar 27, 2025
6 checks passed
@jcstein jcstein deleted the jcs/fixup-evm-sections branch March 27, 2025 18:05
@coderabbitai coderabbitai bot mentioned this pull request Mar 28, 2025
@coderabbitai coderabbitai bot mentioned this pull request May 9, 2025
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