Skip to content

docs: add Windows prerequisites page and WSL troubleshooting#1850

Merged
miyoungc merged 6 commits intomainfrom
docs/add-windows-instruction
Apr 14, 2026
Merged

docs: add Windows prerequisites page and WSL troubleshooting#1850
miyoungc merged 6 commits intomainfrom
docs/add-windows-instruction

Conversation

@miyoungc
Copy link
Copy Markdown
Contributor

@miyoungc miyoungc commented Apr 13, 2026

Summary

Preview: https://nvidia.github.io/NemoClaw/pr-preview/pr-1850/get-started/windows-setup.html

Windows users need WSL 2, Ubuntu, and Docker Desktop configured before the Quickstart installer can run. This PR adds a Windows Prerequisites page under Get Started and merges Windows-specific troubleshooting entries into the existing Troubleshooting reference.

Changes

  • Add docs/get-started/windows-setup.md covering WSL 2 enablement, Ubuntu registration, Docker Desktop with WSL 2 backend, and optional Ollama setup in WSL.
  • Add a "Windows Subsystem for Linux" troubleshooting section to docs/reference/troubleshooting.md with entries for WSL install failures, Docker in WSL, and Ollama context length issues.
  • Add toctree entry in docs/index.md under Get Started.
  • Add link from the quickstart platform matrix to the new Windows Prerequisites page.

Type of Change

  • Code change for a new feature, bug fix, or refactor.
  • Code change with doc updates.
  • Doc only. Prose changes without code sample modifications.
  • Doc only. Includes code sample changes.

Testing

  • npx prek run --all-files passes (or equivalently make check).
  • npm test passes.
  • make docs builds without warnings. (for doc-only changes)

Checklist

General

Doc Changes

  • Follows the style guide. Try running the nemoclaw-contributor-update-docs agent skill to draft changes while complying with the style guide. For example, prompt your agent with "/nemoclaw-contributor-update-docs catch up the docs for the new changes I made in this PR."
  • New pages include SPDX license header and frontmatter, if creating a new page.
  • Cross-references and links verified.

Summary by CodeRabbit

  • Documentation
    • Published a Windows-only setup guide covering WSL 2, Ubuntu registration, Docker Desktop (WSL backend), and optional Ollama in WSL; includes next-step guidance to continue the Quickstart and a new WSL troubleshooting section.
    • Expanded troubleshooting with fixes for WSL install errors, distribution registration, Docker connectivity, and Ollama inference/port issues.
    • Updated skill guidance to reference the Windows prerequisites.
  • Chores
    • Improved prerequisite formatting in generated docs for clearer visual separation.

Windows users need WSL 2, Ubuntu, and Docker Desktop configured
before the Quickstart installer can run. This adds a dedicated
prerequisites page under Get Started and merges Windows-specific
troubleshooting into the existing Troubleshooting reference.

Also fixes the docs-to-skills script to insert a blank line
between paragraph text and list items in merged prerequisites.

Made-with: Cursor
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Apr 13, 2026

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 1b2d2d4a-3538-4933-b68b-4ef40737f64d

📥 Commits

Reviewing files that changed from the base of the PR and between c0a3362 and c64e8ef.

📒 Files selected for processing (2)
  • .agents/skills/nemoclaw-user-get-started/references/windows-setup.md
  • scripts/docs-to-skills.py
✅ Files skipped from review due to trivial changes (1)
  • .agents/skills/nemoclaw-user-get-started/references/windows-setup.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • scripts/docs-to-skills.py

📝 Walkthrough

Walkthrough

Added Windows-specific onboarding and troubleshooting for running NemoClaw via WSL2 (Ubuntu), Docker Desktop WSL integration, and optional Ollama in WSL; updated the NemoClaw skill README to reference Windows prerequisites; and adjusted docs-to-skills link/prerequisite parsing.

Changes

Cohort / File(s) Summary
Windows Setup docs
docs/get-started/windows-setup.md, docs/index.md
New Windows-only prerequisites page and hidden index entry: supported Windows versions, enable WSL2, register/launch Ubuntu (avoid --no-launch), verify wsl -l -v, install Docker Desktop with WSL integration, optional Ollama in WSL, verification and next-step guidance.
WSL Troubleshooting
docs/reference/troubleshooting.md, .agents/skills/nemoclaw-user-reference/references/troubleshooting.md
Added a “Windows Subsystem for Linux” troubleshooting section covering wsl --install --no-distribution 403 (network/VPN), unregistered Ubuntu distro, docker info failing inside WSL (Docker Desktop/WSL integration, restart WSL), and Ollama inference hangs (env var, restart, ollama run, systemd/service handling).
Skill README & reference
.agents/skills/nemoclaw-user-get-started/SKILL.md, .agents/skills/nemoclaw-user-get-started/references/windows-setup.md
Updated skill description to mention Windows-only prerequisites and added a Windows Prerequisites reference linking to the new WSL/Docker/Ollama setup doc.
Docs generation script
scripts/docs-to-skills.py
Link resolution now ignores fragment anchors when checking target suffixes; prerequisite normalization adjusted to insert a blank line when a new bullet (- ) follows a non-bullet item to separate groups while preserving deduplication.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Poem

🐇 I hopped into WSL's soft light,

Ubuntu woke and Docker took flight,
Ollama hummed, ports set free,
Docs pointed the path for me.
— a cheerful rabbit

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 66.67% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main changes: adding a Windows prerequisites page and WSL troubleshooting documentation.

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

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/add-windows-instruction

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

@miyoungc miyoungc requested review from cv and jieunl24 April 13, 2026 23:40
@miyoungc miyoungc changed the title docs: add windows instruction docs: add Windows prerequisites page and WSL troubleshooting Apr 13, 2026
Copy link
Copy Markdown
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: 1

🧹 Nitpick comments (2)
docs/get-started/windows-setup.md (2)

112-121: Use a bottom Next Steps section (plural).

This section is titled Next Step and is followed by another H2 section, so it is not the required bottom Next Steps section.

As per coding guidelines: "A 'Next Steps' section at the bottom links to related pages."

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/get-started/windows-setup.md` around lines 112 - 121, The H2 heading "##
Next Step" should be renamed to "## Next Steps" and positioned as the
bottom-most section per guidelines; update the heading text and, if necessary,
move this block so it appears after the Troubleshooting section (or make
Troubleshooting a subsection) and keep the existing links to
[Quickstart](quickstart.md) and the Windows WSL Troubleshooting link intact;
ensure the final document ends with the "Next Steps" section linking to related
pages.

3-3: Align H1 with frontmatter page title.

Line 23 (# Windows Prerequisites) does not exactly match title.page on Line 3 (Windows Prerequisites for NemoClaw).

As per coding guidelines: "H1 heading matches the title.page frontmatter value."

Also applies to: 23-23

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/get-started/windows-setup.md` at line 3, Update the H1 heading to
exactly match the frontmatter page title: change the heading text currently "#
Windows Prerequisites" to "# Windows Prerequisites for NemoClaw" so it matches
the frontmatter entry page: "Windows Prerequisites for NemoClaw"; ensure the H1
string is identical (including punctuation and capitalization).
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/get-started/windows-setup.md`:
- Line 121: The cross-reference currently links to a broken local target
"windows-wsl-2"; update the markdown link in docs/get-started/windows-setup.md
to point to the actual troubleshooting page for "Windows Subsystem for Linux"
using the repository's canonical doc slug/URL (the correct target for that page
is "windows-wsl-2") so the link resolves in CI (replace the invalid local path
with the correct relative/absolute docs link or site permalink and re-run the
link checker).

---

Nitpick comments:
In `@docs/get-started/windows-setup.md`:
- Around line 112-121: The H2 heading "## Next Step" should be renamed to "##
Next Steps" and positioned as the bottom-most section per guidelines; update the
heading text and, if necessary, move this block so it appears after the
Troubleshooting section (or make Troubleshooting a subsection) and keep the
existing links to [Quickstart](quickstart.md) and the Windows WSL
Troubleshooting link intact; ensure the final document ends with the "Next
Steps" section linking to related pages.
- Line 3: Update the H1 heading to exactly match the frontmatter page title:
change the heading text currently "# Windows Prerequisites" to "# Windows
Prerequisites for NemoClaw" so it matches the frontmatter entry page: "Windows
Prerequisites for NemoClaw"; ensure the H1 string is identical (including
punctuation and capitalization).
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 7ac5dc95-473c-47b8-bb02-aa8d3b68ad69

📥 Commits

Reviewing files that changed from the base of the PR and between 3da97a2 and fa1198c.

📒 Files selected for processing (6)
  • .agents/skills/nemoclaw-user-get-started/SKILL.md
  • .agents/skills/nemoclaw-user-reference/references/troubleshooting.md
  • docs/get-started/windows-setup.md
  • docs/index.md
  • docs/reference/troubleshooting.md
  • scripts/docs-to-skills.py

@miyoungc miyoungc added the documentation Improvements or additions to documentation label Apr 13, 2026
Copy link
Copy Markdown
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: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In @.agents/skills/nemoclaw-user-get-started/SKILL.md:
- Around line 96-100: The Windows WSL/Docker prerequisite block must be moved
before the Quickstart steps in the source documentation (do not edit
.agents/skills/nemoclaw-user-get-started/SKILL.md directly); update the
corresponding docs/ markdown file that generates this skill so the WSL
prerequisites appear before Steps 1–3, then run the generator
scripts/docs-to-skills.py to regenerate the
.agents/skills/nemoclaw-user-get-started/* SKILL.md files; ensure the change
targets the source doc referenced by the skill generation and verify the
regenerated SKILL.md reflects the new ordering.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: ae16f7d4-cfd3-4017-95a0-3669f1de1704

📥 Commits

Reviewing files that changed from the base of the PR and between c5df0cf and 78368dd.

📒 Files selected for processing (2)
  • .agents/skills/nemoclaw-user-get-started/SKILL.md
  • docs/get-started/windows-setup.md
✅ Files skipped from review due to trivial changes (1)
  • docs/get-started/windows-setup.md

The link resolver skipped paths like troubleshooting.md#anchor because
they don't end with .md. Strip the fragment before checking the
extension so these links resolve to skill references correctly.

Made-with: Cursor
@miyoungc miyoungc merged commit 6d36476 into main Apr 14, 2026
13 checks passed
ericksoa pushed a commit to cheese-head/NemoClaw that referenced this pull request Apr 14, 2026
…1850)

<!-- markdownlint-disable MD041 -->
## Summary

Preview:
https://nvidia.github.io/NemoClaw/pr-preview/pr-1850/get-started/windows-setup.html

Windows users need WSL 2, Ubuntu, and Docker Desktop configured before
the Quickstart installer can run. This PR adds a Windows Prerequisites
page under Get Started and merges Windows-specific troubleshooting
entries into the existing Troubleshooting reference.

## Changes

- Add `docs/get-started/windows-setup.md` covering WSL 2 enablement,
Ubuntu registration, Docker Desktop with WSL 2 backend, and optional
Ollama setup in WSL.
- Add a "Windows Subsystem for Linux" troubleshooting section to
`docs/reference/troubleshooting.md` with entries for WSL install
failures, Docker in WSL, and Ollama context length issues.
- Add toctree entry in `docs/index.md` under Get Started.
- Add link from the quickstart platform matrix to the new Windows
Prerequisites page.

## Type of Change

- [ ] Code change for a new feature, bug fix, or refactor.
- [ ] Code change with doc updates.
- [x] Doc only. Prose changes without code sample modifications.
- [ ] Doc only. Includes code sample changes.

## Testing

- [ ] `npx prek run --all-files` passes (or equivalently `make check`).
- [ ] `npm test` passes.
- [x] `make docs` builds without warnings. (for doc-only changes)

## Checklist

### General

- [x] I have read and followed the [contributing
guide](https://github.com/NVIDIA/NemoClaw/blob/main/CONTRIBUTING.md).
- [x] I have read and followed the [style
guide](https://github.com/NVIDIA/NemoClaw/blob/main/docs/CONTRIBUTING.md).
(for doc-only changes)

### Doc Changes

- [x] Follows the [style
guide](https://github.com/NVIDIA/NemoClaw/blob/main/docs/CONTRIBUTING.md).
Try running the `nemoclaw-contributor-update-docs` agent skill to draft
changes while complying with the style guide. For example, prompt your
agent with "`/nemoclaw-contributor-update-docs` catch up the docs for
the new changes I made in this PR."
- [x] New pages include SPDX license header and frontmatter, if creating
a new page.
- [x] Cross-references and links verified.

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

* **Documentation**
* Published a Windows-only setup guide covering WSL 2, Ubuntu
registration, Docker Desktop (WSL backend), and optional Ollama in WSL;
includes next-step guidance to continue the Quickstart and a new WSL
troubleshooting section.
* Expanded troubleshooting with fixes for WSL install errors,
distribution registration, Docker connectivity, and Ollama
inference/port issues.
  * Updated skill guidance to reference the Windows prerequisites.
* **Chores**
* Improved prerequisite formatting in generated docs for clearer visual
separation.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
ColinM-sys pushed a commit to ColinM-sys/NemoClaw that referenced this pull request Apr 14, 2026
…1850)

<!-- markdownlint-disable MD041 -->
## Summary

Preview:
https://nvidia.github.io/NemoClaw/pr-preview/pr-1850/get-started/windows-setup.html

Windows users need WSL 2, Ubuntu, and Docker Desktop configured before
the Quickstart installer can run. This PR adds a Windows Prerequisites
page under Get Started and merges Windows-specific troubleshooting
entries into the existing Troubleshooting reference.

## Changes

- Add `docs/get-started/windows-setup.md` covering WSL 2 enablement,
Ubuntu registration, Docker Desktop with WSL 2 backend, and optional
Ollama setup in WSL.
- Add a "Windows Subsystem for Linux" troubleshooting section to
`docs/reference/troubleshooting.md` with entries for WSL install
failures, Docker in WSL, and Ollama context length issues.
- Add toctree entry in `docs/index.md` under Get Started.
- Add link from the quickstart platform matrix to the new Windows
Prerequisites page.

## Type of Change

- [ ] Code change for a new feature, bug fix, or refactor.
- [ ] Code change with doc updates.
- [x] Doc only. Prose changes without code sample modifications.
- [ ] Doc only. Includes code sample changes.

## Testing

- [ ] `npx prek run --all-files` passes (or equivalently `make check`).
- [ ] `npm test` passes.
- [x] `make docs` builds without warnings. (for doc-only changes)

## Checklist

### General

- [x] I have read and followed the [contributing
guide](https://github.com/NVIDIA/NemoClaw/blob/main/CONTRIBUTING.md).
- [x] I have read and followed the [style
guide](https://github.com/NVIDIA/NemoClaw/blob/main/docs/CONTRIBUTING.md).
(for doc-only changes)

### Doc Changes

- [x] Follows the [style
guide](https://github.com/NVIDIA/NemoClaw/blob/main/docs/CONTRIBUTING.md).
Try running the `nemoclaw-contributor-update-docs` agent skill to draft
changes while complying with the style guide. For example, prompt your
agent with "`/nemoclaw-contributor-update-docs` catch up the docs for
the new changes I made in this PR."
- [x] New pages include SPDX license header and frontmatter, if creating
a new page.
- [x] Cross-references and links verified.

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

* **Documentation**
* Published a Windows-only setup guide covering WSL 2, Ubuntu
registration, Docker Desktop (WSL backend), and optional Ollama in WSL;
includes next-step guidance to continue the Quickstart and a new WSL
troubleshooting section.
* Expanded troubleshooting with fixes for WSL install errors,
distribution registration, Docker connectivity, and Ollama
inference/port issues.
  * Updated skill guidance to reference the Windows prerequisites.
* **Chores**
* Improved prerequisite formatting in generated docs for clearer visual
separation.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

Signed-off-by: ColinM-sys <cmcdonough@50words.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants