Skip to content

Supersim install clarification #1455

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

Closed
wants to merge 4 commits into from
Closed

Conversation

bradleycamacho
Copy link
Member

@bradleycamacho bradleycamacho commented Mar 5, 2025

Clarifies that Supersim can be installed in two ways, and clarifies structure throughout

@bradleycamacho bradleycamacho requested a review from a team as a code owner March 5, 2025 15:53
Copy link

netlify bot commented Mar 5, 2025

Deploy Preview for docs-optimism ready!

Name Link
🔨 Latest commit 917898c
🔍 Latest deploy log https://app.netlify.com/sites/docs-optimism/deploys/67c8abde2e31f20008c13488
😎 Deploy Preview https://deploy-preview-1455--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 bot commented Mar 5, 2025

📝 Walkthrough

Walkthrough

The pull request updates the installation instructions for supersim in the documentation file. The changes involve rephrasing and restructuring bullet points in the "Install supersim" section for enhanced clarity. An introductory sentence was added to inform users that they can either download precompiled binaries or install via Homebrew. The individual bullet points were rewritten to explicitly label the two methods—“Prerecompiled binaries” for downloading from the GitHub releases page, and “Homebrew” for installation on OS X and Linux. Additionally, a new line was added to clarify the instruction to start supersim in vanilla mode, and the list detailing chains started in vanilla mode was reformatted for better readability. No modifications have been made to the underlying functionality or to any exported/public entities.

Suggested reviewers

  • krofax
  • fainashalts

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

looks good, the spellcheck seems to be from something else

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

🧹 Nitpick comments (1)
words.txt (1)

307-307: Check the New Keyword Entry for Consistency.
The file follows a pattern of listing keywords in paired casing (e.g., "Preinstalls" followed by "preinstalls"). The newly added entry "Prerecompiled" appears without a corresponding lowercase variant. Please verify if you intended to include only the title-case version. If consistency is desired, consider adding the lowercase "prerecompiled" immediately after line 307.

A suggested diff to add the lowercase variant is as follows:

 306 preinstalls
-307 Prerecompiled
+307 Prerecompiled
+308 prerecompiled
 309 Prestate
🧰 Tools
🪛 LanguageTool

[duplication] ~307-~307: Možný preklep: zopakovali ste slovo
Context: ...l Preinstalls preinstalls Prerecompiled Prestate prestate prestates PREVRANDAO PRICEBUMP pricebum...

(WORD_REPEAT_RULE)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 6aebd06 and 917898c.

📒 Files selected for processing (1)
  • words.txt (1 hunks)
🧰 Additional context used
🪛 LanguageTool
words.txt

[duplication] ~307-~307: Možný preklep: zopakovali ste slovo
Context: ...l Preinstalls preinstalls Prerecompiled Prestate prestate prestates PREVRANDAO PRICEBUMP pricebum...

(WORD_REPEAT_RULE)

⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Redirect rules - docs-optimism
  • GitHub Check: Header rules - docs-optimism
  • GitHub Check: Pages changed - docs-optimism

@bradleycamacho
Copy link
Member Author

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