Skip to content

docs: add Windows symlink and Developer Mode setup instructions#796

Merged
tachyons merged 1 commit intoCircuitVerse:mainfrom
naman79820:docs/windows-readme-update
Jan 14, 2026
Merged

docs: add Windows symlink and Developer Mode setup instructions#796
tachyons merged 1 commit intoCircuitVerse:mainfrom
naman79820:docs/windows-readme-update

Conversation

@naman79820
Copy link
Contributor

@naman79820 naman79820 commented Jan 13, 2026

Fixes #795

Describe the changes you have made in this PR -

  • Updated the README to clearly document Windows-specific setup requirements.
  • Added instructions to enable Windows Developer Mode for proper symlink support.
  • Clarified the need to re-clone the repository after enabling symlinks to avoid build issues.

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?

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

If you used AI assistance:

  • I have reviewed every single line of the AI-generated code
  • I can explain the purpose and logic of each function/component I added
  • I have tested edge cases and understand how the code handles them
  • I have modified the AI output to follow this project's coding standards and conventions

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
    • Significantly enhanced Windows prerequisites documentation with comprehensive symlink setup requirements and detailed step-by-step configuration instructions
    • Introduced organized checklist covering Developer Mode enablement and Git configuration for proper symlink support
    • Expanded guidance with clearer, more thorough instructions to help Windows developers successfully prepare their development environment before cloning and initializing the project

✏️ Tip: You can customize this high-level summary in your review settings.

@netlify
Copy link

netlify bot commented Jan 13, 2026

Deploy Preview for circuitverse ready!

Name Link
🔨 Latest commit d73cf9b
🔍 Latest deploy log https://app.netlify.com/projects/circuitverse/deploys/69668f27f15a3600083f7448
😎 Deploy Preview https://deploy-preview-796--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: 41 (🟢 up 7 from production)
Accessibility: 73 (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 Jan 13, 2026

Walkthrough

The 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)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately and specifically describes the main change: adding Windows symlink and Developer Mode setup instructions to documentation.
Linked Issues check ✅ Passed The PR directly addresses issue #795 by expanding README Windows prerequisites with symlink and Developer Mode setup instructions, matching the expected outcome.
Out of Scope Changes check ✅ Passed All changes are scoped to README documentation updates for Windows prerequisites as requested in issue #795; no unrelated modifications present.
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.

@naman79820
Copy link
Contributor Author

Ready to be reviewed @tachyons @Nihal4777 :))

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

📜 Review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 261dfed and d73cf9b.

📒 Files selected for processing (1)
  • README.md

Copy link
Member

@Nihal4777 Nihal4777 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As an alternative to developer mode, git clone can also be run as an administrator. Developer Mode is still the preferred method

@naman79820
Copy link
Contributor Author

Ok ill update it :))

As an alternative to developer mode, git clone can also be run as an administrator. Developer Mode is still the preferred method

@tachyons tachyons merged commit 0e58e46 into CircuitVerse:main Jan 14, 2026
14 checks passed
@naman79820 naman79820 deleted the docs/windows-readme-update branch January 14, 2026 19:57
abhiraj75 pushed a commit to abhiraj75/cv-frontend-vue that referenced this pull request Jan 25, 2026
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.

🐞 Bug: Update README with clearer Windows setup instructions

3 participants