-
Notifications
You must be signed in to change notification settings - Fork 358
Docs: Add Windows Setup Guide for local development #390
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
Conversation
📝 WalkthroughWalkthroughAdds a Windows-specific manual setup section to the README, detailing steps to create/activate a Python virtual environment and a PowerShell execution policy workaround before continuing with the existing backend manual setup. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. 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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 2
🤖 Fix all issues with AI agents
In `@README.md`:
- Around line 43-46: The markdown code block starting with the opening fence
"```bash" in README.md is missing its closing backticks; fix by adding a closing
"```" immediately after the shown lines (after ".\venv\Scripts\activate") so the
code block is properly terminated and subsequent content renders correctly.
Ensure the closing fence matches the opening fence style (triple backticks).
- Around line 37-46: The Windows Manual Setup stops after activating the
virtualenv and lacks next steps; update README so the virtual environment
instructions are completed (close the code block) and either (A) add a new
"Virtual Environment (Recommended for all platforms)" section before
platform-specific instructions that shows creating/activating the venv, then in
"Windows Manual Setup" simply reference that section and explicitly instruct
Windows users to continue with the general Manual Setup steps (download
Sense2Vec model, pip install -r requirements.txt, run backend server) or (B) if
keeping it Windows-specific, explain the Windows permission issue and then
explicitly state to continue with the general Manual Setup steps 1–3 or opt for
Automated Setup; ensure the README references the "Manual Setup" and "Automated
Setup" sections by name so readers know what to do next.
🧹 Nitpick comments (1)
README.md (1)
44-45: Consider adding PowerShell execution policy guidance.For PowerShell users, the activation command may fail due to execution policy restrictions. Windows users running PowerShell might encounter an error when trying to activate the virtual environment.
💡 Optional enhancement
1. **Create a Virtual Environment (Recommended):** Open your terminal (Command Prompt or PowerShell) in the root directory and run: ```bash python -m venv venv .\venv\Scripts\activate ``` + + **Note for PowerShell users:** If you encounter an execution policy error, run: + ```powershell + Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser + ``` + Then retry the activation command.

Description
This PR adds a dedicated setup guide for Windows users (
docs/setup/windows.md) and updates the README to link to it.Motivation
Currently, the documentation primarily targets Linux/macOS environments. By providing clear, step-by-step instructions for Windows, we lower the barrier to entry for new contributors. This aligns with the goal of improving community onboarding and governance.
Changes
docs/setup/windows.mdREADME.mdwith a "Windows Setup" badge/link.Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.