[codex] docs(support): align support statuses with PRD definitions#1413
Open
13ernkastel wants to merge 7 commits intoNVIDIA:mainfrom
Open
[codex] docs(support): align support statuses with PRD definitions#141313ernkastel wants to merge 7 commits intoNVIDIA:mainfrom
13ernkastel wants to merge 7 commits intoNVIDIA:mainfrom
Conversation
Signed-off-by: 13ernkastel <LennonCMJ@live.com>
Contributor
|
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:
📝 WalkthroughWalkthroughDocumentation edits across multiple README and docs files adding explicit per-platform and per-provider status labels (Supported, Caveated, Experimental, Out of scope) and clarifying routed inference compatibility and caveats for local providers (e.g., Local Ollama). 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}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
docs/about/overview.md (1)
48-48: Split this into one sentence per source line.Line 48 has two sentences on the same line; please split them into separate lines for diff readability.
As per coding guidelines, "One sentence per line in source (makes diffs readable). Flag paragraphs where multiple sentences appear on the same line."
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/about/overview.md` at line 48, The table row under the "Routed inference" entry currently contains two sentences on one source line; split them so each sentence is on its own line for readable diffs. Edit the Markdown table cell text for "Routed inference" (the sentence starting "Provider-routed model calls through the OpenShell gateway, transparent to the agent." and the sentence starting "Supports NVIDIA Endpoints, OpenAI, Anthropic, Google Gemini, compatible OpenAI or Anthropic endpoints, and the caveated Local Ollama path.") and place each sentence on its own line within that table cell.
🤖 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/quickstart.md`:
- Line 68: The table row linking "DGX Spark" currently points to a GitHub repo;
replace that href with an official NVIDIA documentation or product page URL
(e.g., NVIDIA's DGX/Spark or Docker+cgroup v2 official guide) so the cell "Refer
to the [DGX Spark setup guide]" links to an official tool/doc page rather than a
third-party code repository; update only the URL target while keeping the link
text unchanged ("DGX Spark setup guide") to satisfy docs/ link policy.
---
Nitpick comments:
In `@docs/about/overview.md`:
- Line 48: The table row under the "Routed inference" entry currently contains
two sentences on one source line; split them so each sentence is on its own line
for readable diffs. Edit the Markdown table cell text for "Routed inference"
(the sentence starting "Provider-routed model calls through the OpenShell
gateway, transparent to the agent." and the sentence starting "Supports NVIDIA
Endpoints, OpenAI, Anthropic, Google Gemini, compatible OpenAI or Anthropic
endpoints, and the caveated Local Ollama path.") and place each sentence on its
own line within that table cell.
🪄 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: 9b063569-c764-42a2-8499-b007c0a997b0
📒 Files selected for processing (9)
.agents/skills/nemoclaw-overview/SKILL.md.agents/skills/nemoclaw-overview/references/overview.md.agents/skills/nemoclaw-reference/references/commands.md.agents/skills/nemoclaw-reference/references/inference-profiles.mdREADME.mddocs/about/overview.mddocs/get-started/quickstart.mddocs/reference/commands.mddocs/reference/inference-profiles.md
Signed-off-by: 13ernkastel <LennonCMJ@live.com>
wscurran
added
documentation
Contributor
✨ Thanks for submitting this pull request, which proposes a way to improve documentation clarity by aligning platform and provider support statuses with PRD definitions.Possibly related open issues: |
Contributor
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 `@docs/get-started/quickstart.md`:
- Line 65: Update the platform support matrix row that currently reads "Windows
WSL | Docker Desktop (WSL backend) | Supported | Supported target path." in
docs/get-started/quickstart.md so it refers specifically to "Windows WSL2" and
change its support status from "Supported" to "Out of scope" (i.e., replace the
two "Supported" cells with "Out of scope" where applicable); ensure the row text
uses the exact phrase "Windows WSL2" for clarity and matches the PR/issue
objective of marking WSL2 as out of scope.
🪄 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: f7b1505d-74e7-48a1-a65e-c4791031b811
📒 Files selected for processing (6)
.agents/skills/nemoclaw-configure-inference/references/inference-options.md.agents/skills/nemoclaw-reference/references/inference-profiles.mdREADME.mddocs/get-started/quickstart.mddocs/inference/inference-options.mddocs/reference/commands.md
✅ Files skipped from review due to trivial changes (3)
- docs/reference/commands.md
- .agents/skills/nemoclaw-configure-inference/references/inference-options.md
- .agents/skills/nemoclaw-reference/references/inference-profiles.md
🚧 Files skipped from review as they are similar to previous changes (1)
- README.md
Contributor
Author
|
Addressed the remaining PR 1413 doc follow-ups in
Validation:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Aligns the platform and provider support labels in the user-facing docs with the PRD definitions called out in issue #1402.
The docs previously mixed explicit statuses with implied support, which left macOS, WSL2, Jetson, Windows native, and Local Ollama described inconsistently.
Related Issue
Closes #1402.
Changes
Supported,Caveated, andOut of scopelabels to the platform runtime tables inREADME.mdanddocs/get-started/quickstart.md.Out of scopein the platform support matrix.Caveatedand kept Local NVIDIA NIM and Local vLLM explicitlyExperimental.Type of Change
Testing
npx prek run --all-filespasses (or equivalentlymake check).npm testpasses.make docsbuilds without warnings. (for doc-only changes)Additional checks:
npx markdownlint-cli2 README.md docs/about/overview.md docs/get-started/quickstart.md docs/reference/commands.md docs/reference/inference-profiles.md .agents/skills/nemoclaw-overview/SKILL.md .agents/skills/nemoclaw-overview/references/overview.md .agents/skills/nemoclaw-reference/references/commands.md .agents/skills/nemoclaw-reference/references/inference-profiles.mdLC_ALL=en_US.UTF-8 LANG=en_US.UTF-8 make docsChecklist
General
Code Changes
npx prek run --all-filesauto-fixes formatting (ormake formatfor targeted runs).Doc Changes
update-docsagent skill to draft changes while complying with the style guide. For example, prompt your agent with "/update-docscatch up the docs for the new changes I made in this PR."Signed-off-by: 13ernkastel LennonCMJ@live.com
Summary by CodeRabbit