-
Notifications
You must be signed in to change notification settings - Fork 264
Add missing commands and help text to supersim docs #1669
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
Conversation
✅ Deploy Preview for docs-optimism ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
📝 WalkthroughWalkthroughThe documentation for the 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
Suggested reviewers
📜 Recent review detailsConfiguration used: .coderabbit.yaml 📒 Files selected for processing (2)
🚧 Files skipped from review as they are similar to previous changes (2)
⏰ Context from checks skipped due to timeout of 90000ms (4)
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed 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)
Other keywords and placeholders
Documentation and Community
|
There was a problem hiding this 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!
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
andsupersim fork --help
text.