docs: add Windows symlink and Developer Mode setup instructions#796
Conversation
✅ Deploy Preview for circuitverse ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
WalkthroughThe README.md Windows prerequisites section was expanded to provide clearer setup instructions for enabling Git symlinks. The section now includes a detailed numbered checklist covering Windows Developer Mode enablement and Git configuration for symlinks, along with instructions to re-clone the repository. The previous minimal note with a code snippet was replaced with this comprehensive guide that embeds the core.symlinks configuration command within the expanded setup steps. No logic changes were made outside the prerequisites documentation. 🚥 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 |
|
Ready to be reviewed @tachyons @Nihal4777 :)) |
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
README.md (1)
15-28: Great addition! Documentation clearly addresses issue #795.The Windows prerequisites section effectively documents the symlink requirements and provides clear setup instructions. The two-step approach (Developer Mode + Git configuration) is technically correct and matches Windows best practices.
📝 Optional clarity improvements
Consider these minor refinements for even better user experience:
1. Clarify re-clone timing
The current phrasing "After enabling the above" on Line 28 could be interpreted as "after step 2 only." Consider making it explicit that users should complete BOTH steps before re-cloning:
- After enabling the above, re-clone the repository to ensure symlinks are created correctly. + +**Important:** After completing both steps above, re-clone the repository to ensure symlinks are created correctly.2. More specific Developer Mode path (optional)
While the current instructions work, you could provide more detailed navigation for Windows 10/11:
- Open **Windows Settings**, search for **"Developer settings"**, and turn **Developer Mode** ON. + Open **Settings** → **Privacy & Security** → **For developers** (or search for "Developer settings"), and turn **Developer Mode** ON.Note: The exact path varies between Windows 10 and 11, so the search approach in the current version is actually quite robust.
|
Ok ill update it :))
|

Fixes #795
Describe the changes you have made in this PR -
Screenshots of the UI changes (If any) -
Code Understanding and AI Usage
Did you use AI assistance (ChatGPT, Claude, Copilot, etc.) to write any part of this code?
If you used AI assistance:
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
✏️ Tip: You can customize this high-level summary in your review settings.