Skip to content

Conversation

its-everdred
Copy link
Contributor

Problem

The supersim docs include two sets of --help menu text. Both have outdated text and are missing commands.

Solution

Add all missing commands from supersim --help and supersim fork --help text.

@its-everdred its-everdred requested a review from a team as a code owner June 24, 2025 22:44
Copy link

netlify bot commented Jun 24, 2025

Deploy Preview for docs-optimism ready!

Name Link
🔨 Latest commit bfdd6bd
🔍 Latest deploy log https://app.netlify.com/projects/docs-optimism/deploys/685b2d80166c3f0008b21b3d
😎 Deploy Preview https://deploy-preview-1669--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 project configuration.

Copy link
Contributor

coderabbitai bot commented Jun 24, 2025

📝 Walkthrough

Walkthrough

The documentation for the supersim CLI was updated in both the fork and vanilla reference pages. For the fork command, the list of supported mainnet chains was expanded, and several new CLI options were documented, including those for admin server port configuration, custom L2ToL2CrossDomainMessenger artifacts, L2 chain count, host addresses, odyssey feature toggling, and dependency set overrides. Redundant and duplicate documentation entries were removed or consolidated, and formatting was improved. For vanilla mode, a new docs command was added, and global options were reorganized and expanded to align with the fork command's new options, with minor formatting adjustments in the "Next steps" section.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant CLI
    participant AdminServer
    participant L1Instance
    participant L2Instance

    User->>CLI: Run supersim (fork/vanilla) with new options
    CLI->>AdminServer: Start admin server (--admin.port)
    CLI->>L1Instance: Start L1 with specified host (--l1.host)
    CLI->>L2Instance: Start L2(s) with specified host and count (--l2.host, --l2.count)
    CLI->>CLI: Apply custom artifacts/overrides (--interop.l2tol2cdm.override, --dependency.set)
    CLI->>CLI: Enable odyssey features if specified (--odyssey.enabled)
    User->>CLI: Use new docs command (vanilla mode)
    CLI->>User: Display documentation links
Loading

Suggested reviewers

  • winnsterx
  • fainashalts

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 97dfe44 and bfdd6bd.

📒 Files selected for processing (2)
  • pages/app-developers/tutorials/supersim/reference/fork.mdx (3 hunks)
  • pages/app-developers/tutorials/supersim/reference/vanilla.mdx (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
  • pages/app-developers/tutorials/supersim/reference/fork.mdx
  • pages/app-developers/tutorials/supersim/reference/vanilla.mdx
⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: Redirect rules - docs-optimism
  • GitHub Check: Header rules - docs-optimism
  • GitHub Check: Pages changed - docs-optimism
  • GitHub Check: pr-workflow

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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in this 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.

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
Collaborator

@sbvegan sbvegan left a comment

Choose a reason for hiding this comment

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

thanks for fixing this!

@sbvegan sbvegan merged commit 11d77c0 into main Jun 24, 2025
12 checks passed
@sbvegan sbvegan deleted the kevin/361-configurable-dependency-set branch June 24, 2025 23:03
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