docs: add support matrix reference page#1415
docs: add support matrix reference page#1415WuKongAI-CMU wants to merge 1 commit intoNVIDIA:mainfrom
Conversation
📝 WalkthroughWalkthroughAdded a NemoClaw “Support Matrix” reference page detailing platform/runtime, inference-provider, and deployment-path compatibility; integrated links to it from the NemoClaw agent skill reference, README, and docs homepage for discoverability. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 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)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (1)
docs/reference/support-matrix.md (1)
59-59: Consider rewording to active voice.The phrase "are documented today" uses passive voice and includes filler. Consider using active voice: "NemoClaw supports the following deployment paths." or "The following deployment paths are supported."
As per coding guidelines: "Active voice required. Flag passive constructions."
♻️ Suggested active voice alternatives
Option 1 (preferred):
-The following deployment paths are documented today. +NemoClaw supports the following deployment paths.Option 2:
-The following deployment paths are documented today. +The following deployment paths are supported.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/reference/support-matrix.md` at line 59, Replace the passive sentence "The following deployment paths are documented today." with an active-voice phrasing; for example change that exact sentence to "NemoClaw supports the following deployment paths." or "The following deployment paths are supported." Update the single sentence (the line containing "The following deployment paths are documented today.") to use the chosen active phrasing.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@docs/reference/support-matrix.md`:
- Line 59: Replace the passive sentence "The following deployment paths are
documented today." with an active-voice phrasing; for example change that exact
sentence to "NemoClaw supports the following deployment paths." or "The
following deployment paths are supported." Update the single sentence (the line
containing "The following deployment paths are documented today.") to use the
chosen active phrasing.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 78afe101-7549-4466-92c8-d04ccedee90c
📒 Files selected for processing (5)
.agents/skills/nemoclaw-reference/SKILL.md.agents/skills/nemoclaw-reference/references/support-matrix.mdREADME.mddocs/index.mddocs/reference/support-matrix.md
wscurran
added
documentation
|
✨ Thanks for submitting this pull request, which proposes a way to improve documentation by adding a centralized support matrix page and making it easily accessible from the main README and docs home. Possibly related open issues: |
|
Thanks for putting this together @WuKongAI-CMU — having a consolidated support matrix page is exactly what #1403 asks for, and the structure you've set up (platforms, providers, deployment paths, version requirements) is solid. There are a few things that need to be addressed before this can merge: 1. Merge conflicts (blocking). The PR has conflicts in 2. DCO sign-off missing (blocking). Please add to the bottom of the PR description: 3. Status labels conflict with PR #1413 (blocking). PR #1413 (which is closer to landing) establishes the following statuses that differ from your matrix:
After rebasing, please align your support matrix with these statuses so the page is consistent on day one. 4. Missing platform/runtime entries. Comparing against the current README on main:
5. DGX Spark notes mismatch. Your matrix says "Follow the DGX Spark setup guide for cgroup v2 and Docker configuration" but the README says "Use the standard installer and 6. Passive voice (minor). "The following deployment paths are documented today" → "NemoClaw supports the following deployment paths." I'd suggest waiting for PR #1413 to merge first, then rebasing this PR and aligning all the tables accordingly. Happy to help review again once updated. |
Signed-off-by: Intern Dev <dev@wukongai.io>
WuKongAI-CMU
force-pushed
the
docs/1403-support-matrix
branch
from
c444113 to
90d57b2
Compare
There was a problem hiding this comment.
Actionable comments posted: 5
🧹 Nitpick comments (2)
docs/reference/support-matrix.md (1)
86-89: Consider varied sentence openers in Next Steps (optional).Static analysis flagged that three successive bullets begin with "Use." While this parallel structure is acceptable and common in bulleted lists, you could optionally vary the openers for stylistic variety:
Optional refactor for sentence variety
- Use the [Quickstart](../get-started/quickstart.md) to install NemoClaw on a supported platform. -- Use [Inference Options](../inference/inference-options.md) to compare provider-specific behavior and validation. -- Use [Deploy to a Remote GPU Instance](../deployment/deploy-to-remote-gpu.md) for persistent remote deployment. -- Use [Troubleshooting](../reference/troubleshooting.md) if your environment does not match the supported matrix. +- Compare provider-specific behavior and validation in [Inference Options](../inference/inference-options.md). +- Deploy to a [Remote GPU Instance](../deployment/deploy-to-remote-gpu.md) for persistent remote deployment. +- See [Troubleshooting](../reference/troubleshooting.md) if your environment does not match the supported matrix.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/reference/support-matrix.md` around lines 86 - 89, The three consecutive bullet items that currently start with "Use" ("Use the [Quickstart]...", "Use [Inference Options]...", "Use [Deploy to a Remote GPU Instance]...") could be varied for stylistic diversity: edit one or two of those bullets to start with different verbs or phrasings (for example, "See the [Quickstart]...", "Compare provider behavior in [Inference Options]...", "Deploy via [Deploy to a Remote GPU Instance]...") while keeping the same links and meaning; leave the last bullet ("Use [Troubleshooting]...") or adjust similarly so the list no longer has three identical openers in a row..agents/skills/nemoclaw-reference/references/support-matrix.md (1)
37-37: Use active voice.The phrase "are documented today" uses passive voice. Rephrase to active voice, for example: "The docs cover the following deployment paths."
Note: Since this is a generated skill file, fix the corresponding source in
docs/reference/support-matrix.md(line 59) if needed, then regenerate this file usingpython scripts/docs-to-skills.py. The docs source already uses active voice correctly.As per coding guidelines: Active voice required. Flag passive constructions.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In @.agents/skills/nemoclaw-reference/references/support-matrix.md at line 37, Replace the passive sentence "The following deployment paths are documented today." with an active-voice phrasing such as "The docs cover the following deployment paths." Make the same change in the original documentation source (the support-matrix entry) so the generated skill file doesn't revert, then regenerate the skill using the docs-to-skills.py tooling so the generated support-matrix.md reflects the active-voice fix.
🤖 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-reference/references/support-matrix.md:
- Around line 10-17: Update the canonical docs file
docs/reference/support-matrix.md (not .agents/skills) to add the missing
platform/runtime rows: add "Linux | Podman | Supported/Notes" for Podman on
Linux, "macOS (Apple Silicon) | Podman | Supported" for Podman on Apple Silicon,
"macOS (Intel) | Colima | Supported" for Colima on Intel macOS, and "macOS
(Intel) | Docker Desktop | Supported" for Docker Desktop on Intel macOS; ensure
the phrasing and Notes match existing rows (e.g., mention starting Colima/Docker
Desktop and any caveats), save the file, then regenerate the skill file by
running python scripts/docs-to-skills.py so the
.agents/skills/nemoclaw-reference/references/support-matrix.md is updated
accordingly.
- Line 17: Update the DGX Spark row in support-matrix.md so it matches the rest
of the docs: replace the current guidance that tells users to "Follow the DGX
Spark setup guide for cgroup v2 and Docker configuration" with the standard
recommendation to "use the standard installer and `nemoclaw onboard`" (and
remove the cgroup v2/Docker special-case wording); ensure the cell for "DGX
Spark | Docker" reads that DGX Spark is supported via the standard
installer/onboard flow and note that `nemoclaw setup-spark` is deprecated to
align with README, quickstart, commands.md, and troubleshooting guidance.
In `@docs/reference/support-matrix.md`:
- Around line 32-39: The support matrix table is missing four platform/runtime
rows; add entries for "Linux | Podman", "macOS (Apple Silicon) | Podman", "macOS
(Intel) | Colima", and "macOS (Intel) | Docker Desktop" to the same markdown
table structure used by the existing rows (e.g., the rows for "macOS (Apple
Silicon) | Colima" and "macOS (Intel) | Podman"), and set each row's Status and
Notes to match the canonical guidance from the README (ensure wording and any
prerequisites match existing note style for entries like "Docker Desktop" and
"Colima").
- Around line 32-39: Update the support matrix table rows to use the PR `#1413`
terminology: change the "Windows WSL" row status from "Supported" to "Out of
scope" (refer to the "Windows WSL" row), consolidate the two "macOS (Apple
Silicon)" rows (Colima and Docker Desktop) into a single "macOS (Apple Silicon)"
row with status "Caveated" and merge their Notes (ensure Xcode CLI/Colima and
Docker Desktop startup instructions are preserved), and verify and update the
"Local Ollama" entry so its status matches PR `#1413`'s classification (ensure it
uses "Supported", "Caveated", or "Out of scope" as specified by PR `#1413`).
- Line 39: Update the DGX Spark table row note so it no longer references cgroup
v2 and Docker configuration; locate the row containing the string "DGX Spark |
Docker | Supported with additional setup" and replace the trailing guidance text
with "Use the standard installer and `nemoclaw onboard`." Ensure the change
aligns with README.md, quickstart.md, and commands.md by removing the old cgroup
workaround wording and using the exact phrase requested.
---
Nitpick comments:
In @.agents/skills/nemoclaw-reference/references/support-matrix.md:
- Line 37: Replace the passive sentence "The following deployment paths are
documented today." with an active-voice phrasing such as "The docs cover the
following deployment paths." Make the same change in the original documentation
source (the support-matrix entry) so the generated skill file doesn't revert,
then regenerate the skill using the docs-to-skills.py tooling so the generated
support-matrix.md reflects the active-voice fix.
In `@docs/reference/support-matrix.md`:
- Around line 86-89: The three consecutive bullet items that currently start
with "Use" ("Use the [Quickstart]...", "Use [Inference Options]...", "Use
[Deploy to a Remote GPU Instance]...") could be varied for stylistic diversity:
edit one or two of those bullets to start with different verbs or phrasings (for
example, "See the [Quickstart]...", "Compare provider behavior in [Inference
Options]...", "Deploy via [Deploy to a Remote GPU Instance]...") while keeping
the same links and meaning; leave the last bullet ("Use [Troubleshooting]...")
or adjust similarly so the list no longer has three identical openers in a row.
🪄 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
Run ID: 76ded546-a6bb-4997-afc7-019f6b28a3a1
📒 Files selected for processing (5)
.agents/skills/nemoclaw-reference/SKILL.md.agents/skills/nemoclaw-reference/references/support-matrix.mdREADME.mddocs/index.mddocs/reference/support-matrix.md
✅ Files skipped from review due to trivial changes (2)
- README.md
- docs/index.md
🚧 Files skipped from review as they are similar to previous changes (1)
- .agents/skills/nemoclaw-reference/SKILL.md
| | Host platform | Container runtime | Status | Notes | | ||
| |---|---|---|---| | ||
| | Linux | Docker | Supported | Primary supported path for local and remote installs. | | ||
| | macOS (Apple Silicon) | Colima | Supported | Install Xcode Command Line Tools and start Colima before running the installer. | | ||
| | macOS (Apple Silicon) | Docker Desktop | Supported | Start Docker Desktop before running the installer. | | ||
| | macOS (Intel) | Podman | Not supported | Depends on OpenShell support for Podman on macOS. | | ||
| | Windows WSL | Docker Desktop with WSL backend | Supported | Supported target path for WSL-based installs. | | ||
| | DGX Spark | Docker | Supported with additional setup | Follow the DGX Spark setup guide for cgroup v2 and Docker configuration. | |
There was a problem hiding this comment.
Add missing platform and runtime combinations.
The matrix is missing several platform/runtime entries mentioned in the PR review feedback:
- Podman on Linux
- Podman on macOS (Apple Silicon)
- Colima on macOS (Intel)
- Docker Desktop on macOS (Intel)
Currently only macOS (Intel) + Podman is listed. Compare against the current README to ensure all documented combinations are included.
Note: Fix this in the source file docs/reference/support-matrix.md first, then regenerate this skill file using python scripts/docs-to-skills.py.
As per coding guidelines: Edit documentation under docs/ directory (never .agents/skills/nemoclaw-*/*.md) and regenerate skills with python scripts/docs-to-skills.py.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In @.agents/skills/nemoclaw-reference/references/support-matrix.md around lines
10 - 17, Update the canonical docs file docs/reference/support-matrix.md (not
.agents/skills) to add the missing platform/runtime rows: add "Linux | Podman |
Supported/Notes" for Podman on Linux, "macOS (Apple Silicon) | Podman |
Supported" for Podman on Apple Silicon, "macOS (Intel) | Colima | Supported" for
Colima on Intel macOS, and "macOS (Intel) | Docker Desktop | Supported" for
Docker Desktop on Intel macOS; ensure the phrasing and Notes match existing rows
(e.g., mention starting Colima/Docker Desktop and any caveats), save the file,
then regenerate the skill file by running python scripts/docs-to-skills.py so
the .agents/skills/nemoclaw-reference/references/support-matrix.md is updated
accordingly.
| | macOS (Apple Silicon) | Docker Desktop | Supported | Start Docker Desktop before running the installer. | | ||
| | macOS (Intel) | Podman | Not supported | Depends on OpenShell support for Podman on macOS. | | ||
| | Windows WSL | Docker Desktop with WSL backend | Supported | Supported target path for WSL-based installs. | | ||
| | DGX Spark | Docker | Supported with additional setup | Follow the DGX Spark setup guide for cgroup v2 and Docker configuration. | |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Compare DGX Spark references in README and docs
rg -n -C 3 -i 'dgx spark' README.md docs/Repository: NVIDIA/NemoClaw
Length of output: 4232
Update DGX Spark guidance in support matrix to align with documentation.
The support-matrix.md entry references "Follow the DGX Spark setup guide for cgroup v2 and Docker configuration," but this contradicts guidance elsewhere in the codebase. The README, quickstart, commands reference, and troubleshooting docs consistently state to "use the standard installer and nemoclaw onboard" because current OpenShell releases handle the cgroup behavior. The commands.md even marks nemoclaw setup-spark as deprecated. Update the support-matrix.md entry to match this standard guidance.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In @.agents/skills/nemoclaw-reference/references/support-matrix.md at line 17,
Update the DGX Spark row in support-matrix.md so it matches the rest of the
docs: replace the current guidance that tells users to "Follow the DGX Spark
setup guide for cgroup v2 and Docker configuration" with the standard
recommendation to "use the standard installer and `nemoclaw onboard`" (and
remove the cgroup v2/Docker special-case wording); ensure the cell for "DGX
Spark | Docker" reads that DGX Spark is supported via the standard
installer/onboard flow and note that `nemoclaw setup-spark` is deprecated to
align with README, quickstart, commands.md, and troubleshooting guidance.
| | Host platform | Container runtime | Status | Notes | | ||
| |---|---|---|---| | ||
| | Linux | Docker | Supported | Primary supported path for local and remote installs. | | ||
| | macOS (Apple Silicon) | Colima | Supported | Install Xcode Command Line Tools and start Colima before running the installer. | | ||
| | macOS (Apple Silicon) | Docker Desktop | Supported | Start Docker Desktop before running the installer. | | ||
| | macOS (Intel) | Podman | Not supported | Depends on OpenShell support for Podman on macOS. | | ||
| | Windows WSL | Docker Desktop with WSL backend | Supported | Supported target path for WSL-based installs. | | ||
| | DGX Spark | Docker | Supported with additional setup | Follow the DGX Spark setup guide for cgroup v2 and Docker configuration. | |
There was a problem hiding this comment.
Add missing platform and runtime combinations.
The matrix is missing several platform/runtime entries mentioned in the PR review feedback:
- Podman on Linux (should indicate support status)
- Podman on macOS (Apple Silicon) (currently only Intel+Podman is listed)
- Colima on macOS (Intel) (currently only Apple Silicon+Colima is listed)
- Docker Desktop on macOS (Intel) (currently only Apple Silicon+Docker Desktop is listed)
Compare against the current README to ensure all documented combinations are included for completeness.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/reference/support-matrix.md` around lines 32 - 39, The support matrix
table is missing four platform/runtime rows; add entries for "Linux | Podman",
"macOS (Apple Silicon) | Podman", "macOS (Intel) | Colima", and "macOS (Intel) |
Docker Desktop" to the same markdown table structure used by the existing rows
(e.g., the rows for "macOS (Apple Silicon) | Colima" and "macOS (Intel) |
Podman"), and set each row's Status and Notes to match the canonical guidance
from the README (ensure wording and any prerequisites match existing note style
for entries like "Docker Desktop" and "Colima").
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Fetch and compare support matrix entries with PR `#1413`
echo "=== Checking PR `#1413` for support matrix content ==="
gh pr view 1413 --json files --jq '.files[].path' | rg -i 'readme|support|matrix'
echo -e "\n=== Comparing status entries in PR `#1413` ==="
gh pr diff 1413 | rg -i -C 5 'local ollama|windows.*wsl|macos.*(apple silicon|intel)'Repository: NVIDIA/NemoClaw
Length of output: 431
🏁 Script executed:
# First, check the current state of the support matrix file
git ls-files docs/reference/support-matrix.mdRepository: NVIDIA/NemoClaw
Length of output: 91
🏁 Script executed:
# Look for PR `#1413` references in git history
git log --oneline --all | grep -i "1413\|support.*matrix" | head -20Repository: NVIDIA/NemoClaw
Length of output: 106
🏁 Script executed:
# Read the support matrix file to see current state
wc -l docs/reference/support-matrix.mdRepository: NVIDIA/NemoClaw
Length of output: 94
🏁 Script executed:
# Read the full support matrix file
cat -n docs/reference/support-matrix.mdRepository: NVIDIA/NemoClaw
Length of output: 5177
🏁 Script executed:
# Search for PR `#1413` references in commit messages or branches
git log --all --grep="1413" --oneline
git branch -a | grep -i "1413\|support"Repository: NVIDIA/NemoClaw
Length of output: 130
🏁 Script executed:
# Search more broadly for PR 1413 context
git log --all --oneline | grep -i "support\|ollama\|wsl" | head -30Repository: NVIDIA/NemoClaw
Length of output: 2001
🏁 Script executed:
# Check remote branches
git branch -r | head -20Repository: NVIDIA/NemoClaw
Length of output: 101
🏁 Script executed:
# Search for any mention of "1413" anywhere in git history
git log --all --source --remotes --format="%H %s %b" | grep -i "1413" | head -5Repository: NVIDIA/NemoClaw
Length of output: 184
🌐 Web query:
NemoClaw PR 1413 support matrix
💡 Result:
NemoClaw PR #1413 updates the Container Runtimes / platform support matrix to use explicit status labels (Supported, Caveated, Out of scope). The matrix in that PR’s README is: [1][2]
| Platform | Supported runtimes | Status | Notes |
|---|---|---|---|
| Linux | Docker | Supported | Primary supported path. |
| macOS (Apple Silicon) | Colima, Docker Desktop | Caveated | Requires Xcode Command Line Tools; start runtime before install. |
| macOS (Intel) | Docker Desktop | Caveated | Start runtime before install. |
| Windows WSL2 | Docker Desktop (WSL backend) | Out of scope | Not part of the supported NemoClaw target matrix. |
| Windows native | N/A | Out of scope | Not part of the supported NemoClaw target matrix. |
| Jetson | N/A | Out of scope | Not part of the supported NemoClaw target matrix. |
| DGX Spark | Docker | Supported | Use standard installer and nemoclaw onboard. |
Sources: PR #1413 conversation/summary and the PR branch README content. [1][2]
🏁 Script executed:
# Check if PR `#1413` might be in a separate branch or tag
git tag | grep -i "1413\|release" | head -20Repository: NVIDIA/NemoClaw
Length of output: 41
🏁 Script executed:
# Look at the commit that added support matrix to understand context
git show --stat 90d57b2Repository: NVIDIA/NemoClaw
Length of output: 22181
Align support matrix status labels with PR #1413.
The current support matrix uses status values that differ from PR #1413's terminology. Update to match PR #1413's status classification:
- Windows WSL (line 38): Change from "Supported" to "Out of scope"
- macOS (Apple Silicon) (lines 35–36): Consolidate rows and change status from "Supported" to "Caveated"
- Verify Local Ollama (line 53) status aligns with PR
#1413
PR #1413 establishes "Supported", "Caveated", and "Out of scope" as the standard status labels; the current matrix must reflect these consistently.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/reference/support-matrix.md` around lines 32 - 39, Update the support
matrix table rows to use the PR `#1413` terminology: change the "Windows WSL" row
status from "Supported" to "Out of scope" (refer to the "Windows WSL" row),
consolidate the two "macOS (Apple Silicon)" rows (Colima and Docker Desktop)
into a single "macOS (Apple Silicon)" row with status "Caveated" and merge their
Notes (ensure Xcode CLI/Colima and Docker Desktop startup instructions are
preserved), and verify and update the "Local Ollama" entry so its status matches
PR `#1413`'s classification (ensure it uses "Supported", "Caveated", or "Out of
scope" as specified by PR `#1413`).
| | macOS (Apple Silicon) | Docker Desktop | Supported | Start Docker Desktop before running the installer. | | ||
| | macOS (Intel) | Podman | Not supported | Depends on OpenShell support for Podman on macOS. | | ||
| | Windows WSL | Docker Desktop with WSL backend | Supported | Supported target path for WSL-based installs. | | ||
| | DGX Spark | Docker | Supported with additional setup | Follow the DGX Spark setup guide for cgroup v2 and Docker configuration. | |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Compare DGX Spark setup instructions
echo "=== DGX Spark references in README.md ==="
rg -n -C 5 -i 'dgx spark' README.md
echo -e "\n=== DGX Spark references in docs/ ==="
rg -n -C 5 -i 'dgx spark' docs/Repository: NVIDIA/NemoClaw
Length of output: 6055
Update DGX Spark setup guidance to match current documentation.
The note in support-matrix.md (line 39) says "Follow the DGX Spark setup guide for cgroup v2 and Docker configuration," but this contradicts the guidance in README.md, quickstart.md, and commands.md, which all state "Use the standard installer and nemoclaw onboard."
The troubleshooting guide confirms that the older cgroup workaround is no longer needed: "Current OpenShell releases handle that behavior themselves, so NemoClaw no longer requires a Spark-specific setup step."
Change the note to: "Use the standard installer and nemoclaw onboard."
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/reference/support-matrix.md` at line 39, Update the DGX Spark table row
note so it no longer references cgroup v2 and Docker configuration; locate the
row containing the string "DGX Spark | Docker | Supported with additional setup"
and replace the trailing guidance text with "Use the standard installer and
`nemoclaw onboard`." Ensure the change aligns with README.md, quickstart.md, and
commands.md by removing the old cgroup workaround wording and using the exact
phrase requested.
|
@WuKongAI-CMU pls resolve conflicts and fyi, instead of PR #1413 we have PR #1619 that is now merged ! |
3 participants
Summary
nemoclaw-referenceskill so agent-facing docs stay in syncValidation
Fixes #1403
Summary by CodeRabbit