docs: clarify resetting VITE_SIM_VERSION to return to v0#970
docs: clarify resetting VITE_SIM_VERSION to return to v0#970tachyons merged 2 commits intoCircuitVerse:mainfrom
Conversation
✅ Deploy Preview for circuitverse ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
No actionable comments were generated in the recent review. 🎉 WalkthroughThe README.md Start v1 section was updated to note that after setting 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
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.

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_VERSIONenvironment 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?
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_VERSIONpersists 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
Note: Please check Allow edits from maintainers if you would like us to assist in the PR.
Summary by CodeRabbit