Skip to content

docs(get-started): add Windows WSL2 setup section#1951

Open
hemachandra666 wants to merge 1 commit into
NVIDIA:developfrom
hemachandra666:docs/windows-wsl2-setup
Open

docs(get-started): add Windows WSL2 setup section#1951
hemachandra666 wants to merge 1 commit into
NVIDIA:developfrom
hemachandra666:docs/windows-wsl2-setup

Conversation

@hemachandra666
Copy link
Copy Markdown

@hemachandra666 hemachandra666 commented May 16, 2026

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:

  • I am familiar with the [Contributing Guidelines](https://github.com/NVIDIA/NeMo-Agent Toolkit/blob/develop/docs/source/resources/contributing/index.md).
  • We require that all contributors "sign-off" on their commits. This certifies that the contribution is your original work, or you have rights to submit it under the same license, or a compatible license.
    • Any contribution which contains commits that are not Signed-Off will not be accepted.
  • When the PR is ready for review, new or existing tests cover these changes.
  • When the PR is ready for review, the documentation is up to date with these changes.

Signed-off-by: Kunchala Hema Sai Venkat Chandra Kumar kumarchanduk@gmail.com

Summary by CodeRabbit

  • Documentation
    • Added comprehensive Windows (WSL2) installation guide with step-by-step instructions for WSL2 and Ubuntu setup, Linux user password configuration, installation of required build prerequisites including Git LFS, environment initialization, and guidance for proceeding with the source-based installation workflow from within the WSL2 Ubuntu shell environment.

Review Change Stack

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>
@hemachandra666 hemachandra666 requested a review from a team as a code owner May 16, 2026 06:29
@copy-pr-bot
Copy link
Copy Markdown

copy-pr-bot Bot commented May 16, 2026

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 16, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 23e5f4df-58ea-4378-bd0f-9b068972ac94

📥 Commits

Reviewing files that changed from the base of the PR and between 2dacbce and b3d3289.

📒 Files selected for processing (1)
  • docs/source/get-started/installation.md

Walkthrough

This 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 uv package manager, and proceed with source installation within the WSL2 shell.

Changes

Windows (WSL2) Installation Documentation

Layer / File(s) Summary
WSL2 installation workflow documentation
docs/source/get-started/installation.md
New Windows-specific installation guide section describing WSL2/Ubuntu installation, Linux user setup, build prerequisite and Git LFS installation, uv tool configuration, and continuation of source-install steps within the WSL2 environment.

🎯 2 (Simple) | ⏱️ ~10 minutes

🚥 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 is concise, descriptive, uses imperative mood, and directly reflects the main change—adding Windows WSL2 setup documentation to the installation guide.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

  • Generate code and open pull requests
  • Plan features and break down work
  • Investigate incidents and troubleshoot customer tickets together
  • Automate recurring tasks and respond to alerts with triggers
  • Summarize progress and report instantly

Built for teams:

  • Shared memory across your entire org—no repeating context
  • Per-thread sandboxes to safely plan and execute work
  • Governance built-in—scoped access, auditability, and budget controls

One agent for your entire SDLC. Right inside Slack.

👉 Get started


Comment @coderabbitai help to get the list of available commands and usage tips.

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.

1 participant