Skip to content

docs: clarify resetting VITE_SIM_VERSION to return to v0#970

Merged
tachyons merged 2 commits intoCircuitVerse:mainfrom
Radhikaa-chauhan:docs/sim-version-note
Feb 22, 2026
Merged

docs: clarify resetting VITE_SIM_VERSION to return to v0#970
tachyons merged 2 commits intoCircuitVerse:mainfrom
Radhikaa-chauhan:docs/sim-version-note

Conversation

@Radhikaa-chauhan
Copy link
Contributor

@Radhikaa-chauhan Radhikaa-chauhan commented Feb 17, 2026

Fixes #967

Describe the changes you have made in this PR -

This PR updates the README to clarify how to switch back to the default v0 simulator after running v1 by resetting or unsetting the VITE_SIM_VERSION environment variable.

Screenshots of the UI changes (If any) -

Not Applicable


Code Understanding and AI Usage

Did you use AI assistance (ChatGPT, Claude, Copilot, etc.) to write any part of this code?

  • No, I wrote all the code myself
  • Yes, I used AI assistance (continue below)

Explain your implementation approach:
This PR addresses a documentation gap where contributors may be unsure how to return to the default v0 simulator after running v1.
The approach was to add a brief note in the README explaining that VITE_SIM_VERSION persists and must be reset or unset.

An alternative was to assume prior knowledge of environment variables, but that can confuse new contributors.
This solution was chosen because it is minimal, clear, and improves contributor experience without changing any code.

Key change: a README update only.


Checklist before requesting a review

  • I have added proper PR title and linked to the issue
  • I have performed a self-review of my code
  • I can explain the purpose of every function, class, and logic block I added
  • I understand why my changes work and have tested them thoroughly
  • I have considered potential edge cases and how my code handles them
  • If it is a core feature, I have added thorough tests
  • My code follows the project's style guidelines and conventions

Note: Please check Allow edits from maintainers if you would like us to assist in the PR.

Summary by CodeRabbit

  • Documentation
    • Clarified setup notes: after running v1, you must unset or reset the VITE_SIM_VERSION to v0 to return to the default simulator. Includes platform-specific commands for Windows and macOS/Linux to guide reverting the environment setting.

@netlify
Copy link

netlify bot commented Feb 17, 2026

Deploy Preview for circuitverse ready!

Name Link
🔨 Latest commit 7771365
🔍 Latest deploy log https://app.netlify.com/projects/circuitverse/deploys/6994c6d618f21d00088bf318
😎 Deploy Preview https://deploy-preview-970--circuitverse.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 44 (🔴 down 5 from production)
Accessibility: 66 (no change from production)
Best Practices: 92 (no change from production)
SEO: 82 (no change from production)
PWA: -
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 17, 2026

No actionable comments were generated in the recent review. 🎉


Walkthrough

The README.md Start v1 section was updated to note that after setting VITE_SIM_VERSION to v1, the environment variable persists across sessions. It instructs contributors to either unset the variable or reset it to v0 to return to the default simulator version and includes example commands for Windows and Unix-based systems.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately reflects the main documentation change: clarifying how to reset VITE_SIM_VERSION to return to v0.
Linked Issues check ✅ Passed The PR fulfills issue #967 requirements by adding a note explaining that VITE_SIM_VERSION must be unset or reset to v0, with environment variable examples for both Windows and Unix systems.
Out of Scope Changes check ✅ Passed All changes are strictly documentation-focused (README updates) and directly address the clarification requested in issue #967; no out-of-scope modifications detected.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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

Comment @coderabbitai help to get the list of available commands and usage tips.

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: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@README.md`:
- Around line 41-49: Update the README "Start v1 (Windows/Unix)" section to
split the Windows instruction into separate CMD and PowerShell variants for
setting/unsetting the VITE_SIM_VERSION env var: keep the CMD form using the
traditional set syntax and add a PowerShell form using the PowerShell
environment-variable approach (session-scoped) for both setting and unsetting;
ensure the note refers to the exact env var name VITE_SIM_VERSION and update the
examples under the note to show the correct CMD and PowerShell commands
separately.

@tachyons tachyons merged commit 1a076de into CircuitVerse:main Feb 22, 2026
14 checks passed
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.

docs: clarify how to switch back to v0 after setting v1

2 participants