docs: add Windows prerequisites page and WSL troubleshooting#1850
docs: add Windows prerequisites page and WSL troubleshooting#1850
Conversation
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
|
Note Reviews pausedIt 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 Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (2)
✅ Files skipped from review due to trivial changes (1)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughAdded 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
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
docs/get-started/windows-setup.md (2)
112-121: Use a bottomNext Stepssection (plural).This section is titled
Next Stepand is followed by another H2 section, so it is not the required bottomNext Stepssection.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 matchtitle.pageon Line 3 (Windows Prerequisites for NemoClaw).As per coding guidelines: "H1 heading matches the
title.pagefrontmatter 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
📒 Files selected for processing (6)
.agents/skills/nemoclaw-user-get-started/SKILL.md.agents/skills/nemoclaw-user-reference/references/troubleshooting.mddocs/get-started/windows-setup.mddocs/index.mddocs/reference/troubleshooting.mdscripts/docs-to-skills.py
There was a problem hiding this comment.
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
📒 Files selected for processing (2)
.agents/skills/nemoclaw-user-get-started/SKILL.mddocs/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
…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 -->
…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>
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
docs/get-started/windows-setup.mdcovering WSL 2 enablement, Ubuntu registration, Docker Desktop with WSL 2 backend, and optional Ollama setup in WSL.docs/reference/troubleshooting.mdwith entries for WSL install failures, Docker in WSL, and Ollama context length issues.docs/index.mdunder Get Started.Type of Change
Testing
npx prek run --all-filespasses (or equivalentlymake check).npm testpasses.make docsbuilds without warnings. (for doc-only changes)Checklist
General
Doc Changes
nemoclaw-contributor-update-docsagent skill to draft changes while complying with the style guide. For example, prompt your agent with "/nemoclaw-contributor-update-docscatch up the docs for the new changes I made in this PR."Summary by CodeRabbit