Skip to content

docs: add support matrix reference page#1415

Open
WuKongAI-CMU wants to merge 1 commit intoNVIDIA:mainfrom
WuKongAI-CMU:docs/1403-support-matrix
Open

docs: add support matrix reference page#1415
WuKongAI-CMU wants to merge 1 commit intoNVIDIA:mainfrom
WuKongAI-CMU:docs/1403-support-matrix

Conversation

@WuKongAI-CMU
Copy link
Copy Markdown
Contributor

@WuKongAI-CMU WuKongAI-CMU commented Apr 3, 2026

Summary

  • add a dedicated support matrix page that consolidates platform, runtime, provider, and deployment compatibility
  • link the new page from the root README and docs home page so it is reachable from the main entry points
  • regenerate the nemoclaw-reference skill so agent-facing docs stay in sync

Validation

  • python3 scripts/docs-to-skills.py docs/ .agents/skills/ --prefix nemoclaw
  • make docs

Fixes #1403

Summary by CodeRabbit

Release Notes

  • Documentation
    • Introduced a new Support Matrix reference guide detailing NemoClaw compatibility across host platforms, container runtimes, inference providers, and deployment paths.
    • Integrated Support Matrix throughout documentation navigation and homepage for easy access to compatibility information.
    • Includes version and environment requirements, plus guidance on unsupported configurations.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Apr 3, 2026

📝 Walkthrough

Walkthrough

A new Support Matrix documentation page is added to centralize NemoClaw compatibility information across platforms, runtimes, inference providers, and deployment paths. Navigation links are integrated into the agent skills reference, README, and homepage documentation to make the page discoverable from multiple entry points.

Changes

Cohort / File(s) Summary
Agent Skills Reference
.agents/skills/nemoclaw-reference/SKILL.md, .agents/skills/nemoclaw-reference/references/support-matrix.md
Updated skill description to include support-matrix usage scenario and added reference link. New support matrix page created with platform/runtime, inference provider, deployment path, and version/environment requirements.
Main Documentation
README.md, docs/index.md
Added Support Matrix links in README introduction and documentation table. Added Support Matrix card to homepage grid with reference navigation integration.
Reference Documentation
docs/reference/support-matrix.md
New consolidated support matrix page with platform combinations, inference provider support, deployment paths, and cross-cutting requirements.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A matrix of support, now clear as the day,
Platforms and runtimes all mapped out the way!
From docs to the skills, the links show the path,
Compatibility wisdom, without any wrath! 📚✨

🚥 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 PR title 'docs: add support matrix reference page' clearly and concisely summarizes the main change: adding a new support matrix documentation page.
Linked Issues check ✅ Passed The PR fully addresses issue #1403 by creating a consolidated support matrix page, adding links from README and docs homepage, and ensuring it is reachable from the root README.
Out of Scope Changes check ✅ Passed All changes are directly scoped to implementing the support matrix: new documentation pages, integration into navigation, updates to README/homepage links, and skill regeneration for sync.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

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

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

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.

🧹 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

📥 Commits

Reviewing files that changed from the base of the PR and between 494ecde and c444113.

📒 Files selected for processing (5)
  • .agents/skills/nemoclaw-reference/SKILL.md
  • .agents/skills/nemoclaw-reference/references/support-matrix.md
  • README.md
  • docs/index.md
  • docs/reference/support-matrix.md

@wscurran wscurran added documentation Improvements or additions to documentation priority: medium Issue that should be addressed in upcoming releases enhancement: feature Use this label to identify requests for new capabilities in NemoClaw. labels Apr 3, 2026
@wscurran
Copy link
Copy Markdown
Contributor

wscurran commented Apr 3, 2026

✨ 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:

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 enhancement: feature Use this label to identify requests for new capabilities in NemoClaw. priority: medium Issue that should be addressed in upcoming releases

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[NemoClaw][doc] Missing support matrix / compatibility page — no reachable link from root README

2 participants