docs(get-started): add Windows WSL2 setup section#1951
Conversation
Adds a Windows (WSL2) setup section to the installation guide, covering WSL2 installation, Linux user setup, build prerequisites, and uv installation, then handing off to the existing Install From Source steps. Verified on Windows 11 with Ubuntu 24.04 LTS. Signed-off-by: Kunchala Hema Sai Venkat Chandra Kumar <kumarchanduk@gmail.com> Signed-off-by: Kunchala Hema Sai Venkat Chandra Kumar <72931765+hemachandra666@users.noreply.github.com>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Enterprise Run ID: 📒 Files selected for processing (1)
WalkthroughThis PR adds a new Windows (WSL2) installation section to the getting-started guide, providing step-by-step instructions for users on Windows to set up WSL2, configure their Linux environment, install build prerequisites including Git LFS, install the ChangesWindows (WSL2) Installation Documentation
🎯 2 (Simple) | ⏱️ ~10 minutes 🚥 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)
Tip 💬 Introducing Slack Agent: The best way for teams to turn conversations into code.Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.
Built for teams:
One agent for your entire SDLC. Right inside Slack. Comment |
Adds a Windows (WSL2) setup section to the installation guide, covering WSL2 installation, Linux user setup, build prerequisites, and uv installation, then handing off to the existing Install From Source steps. Verified on Windows 11 with Ubuntu 24.04 LTS.
Description
The installation guide does not document how to set up the toolkit on Windows. The Supported Platforms table lists Windows x86_64 as untested, and the only existing Windows reference is a single line in the contributing guide with no steps. This adds a Windows (WSL2) section to docs/source/get-started/installation.md, placed after Software Prerequisites, that walks through installing WSL2 and Ubuntu, setting up the Linux user, installing build prerequisites including Git LFS, and installing uv. It then hands off to the existing Install From Source steps so nothing is duplicated. All steps were verified end to end on Windows 11 with Ubuntu 24.04 LTS.
By Submitting this PR I confirm:
Signed-off-by: Kunchala Hema Sai Venkat Chandra Kumar kumarchanduk@gmail.com
Summary by CodeRabbit