docs: fix QA-reported command drift#5247
Merged
Merged
Conversation
|
Auto-sync is disabled for draft pull requests in this repository. Workflows must be run manually. Contributors can view more details about this message here. |
Contributor
📝 WalkthroughWalkthroughDocumentation updates across deployment, inference, and reference sections to fix CLI drift and add missing command documentation. Changes include restructuring remote GPU deployment docs to emphasize the preferred installer flow, migrating sub-agent setup from Kubernetes to Docker commands, adding missing shields and config command sections to reference docs, and updating troubleshooting recovery flows to use current OpenShell CLI capabilities instead of non-existent gateway subcommands. ChangesCLI Documentation Alignment and Command Reference
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Suggested labels
Suggested reviewers
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 |
Contributor
|
🌿 Preview your docs: https://nvidia-preview-pr-5247.docs.buildwithfern.com/nemoclaw |
Contributor
E2E Advisor RecommendationRequired E2E: None Full advisor summaryE2E Recommendation AdvisorBase: Required E2E
Optional E2E
New E2E recommendations
|
Contributor
Vitest E2E Scenario RecommendationRequired Vitest E2E scenarios: None Full Vitest E2E advisor summaryVitest E2E Scenario AdvisorBase: Required Vitest E2E scenarios
Optional Vitest E2E scenarios
Relevant changed files
|
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (4)
docs/deployment/deploy-to-remote-gpu.mdx (2)
28-28: ⚡ Quick winUse active voice.
The phrase "created by the Brev CLI" is passive. Rewrite to active voice:
Suggestion: "For Brev, the Brev CLI creates
<instance-name>as both the instance name and SSH alias."🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/deployment/deploy-to-remote-gpu.mdx` at line 28, Rewrite the passive phrase "created by the Brev CLI" to active voice so the sentence reads like an instruction; replace the line containing "<instance-name>" so it says: "For Brev, the Brev CLI creates `<instance-name>` as both the instance name and SSH alias." Use the terms "<instance-name>" and "Brev CLI" to locate and update the sentence.Source: Coding guidelines
46-46: ⚡ Quick winUse present tense.
"you will open" uses future tense. Use present tense when describing current behavior:
Suggestion: "For example, set the browser origin if you open the dashboard through a Brev public URL, and raise the first-run readiness budget on cold cloud hosts:"
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/deployment/deploy-to-remote-gpu.mdx` at line 46, Update the sentence in deploy-to-remote-gpu.mdx that currently reads "For example, set the browser origin if you will open the dashboard through a Brev public URL, and raise the first-run readiness budget on cold cloud hosts:" to present tense; replace "if you will open" with "if you open" so the line reads "For example, set the browser origin if you open the dashboard through a Brev public URL, and raise the first-run readiness budget on cold cloud hosts:" ensuring the example sentence uses present tense.Source: Coding guidelines
docs/inference/set-up-sub-agent.mdx (1)
27-27: ⚡ Quick winSplit sentences onto separate lines.
This table cell contains two sentences on the same line. Per the style guide, use one sentence per line for diff readability.
Suggested rewrite
-| `/sandbox/.openclaw/.config-hash` | Hash for `openclaw.json`. Keep it in sync after manual config edits so OpenClaw can detect the updated config. | +| `/sandbox/.openclaw/.config-hash` | Hash for `openclaw.json`.<br />Keep it in sync after manual config edits so OpenClaw can detect the updated config. |Note: Markdown tables require
<br />to add line breaks within cells while maintaining the one-sentence-per-line principle in the source.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/inference/set-up-sub-agent.mdx` at line 27, The table cell for the `/sandbox/.openclaw/.config-hash` entry contains two sentences on one line; split them into separate lines in the Markdown source (one sentence per line) and add an explicit HTML line break (<br />) between them so the rendered table still shows both sentences on separate lines; keep the text referencing `openclaw.json` and the guidance about syncing after manual edits unchanged.Source: Coding guidelines
docs/reference/commands.mdx (1)
255-255: ⚡ Quick winUse
API key(notAPI-key) for terminology consistency.Line 255 uses
API-key mode; change this toAPI key mode.As per coding guidelines, the correct form is
API keyand incorrect forms should be flagged.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/reference/commands.mdx` at line 255, Replace the incorrect term "API-key mode" with the standardized "API key mode" in the documentation; locate the sentence containing "API-key mode is inference-only and does not enable managed tool gateways." and update it to use "API key mode" to match terminology consistency.Source: Coding guidelines
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/reference/commands.mdx`:
- Line 1627: The docs currently recommend only `$$nemoclaw onboard --resume` but
`--resume` only works when an interrupted resumable onboarding session exists;
update the text to recommend the generic recovery command `$$nemoclaw onboard`
as the default recovery path and mention `--resume` as a conditional option that
should only be used when an interrupted session exists (reflecting the behavior
implemented in onboard.ts which only continues an interrupted onboarding
session).
---
Nitpick comments:
In `@docs/deployment/deploy-to-remote-gpu.mdx`:
- Line 28: Rewrite the passive phrase "created by the Brev CLI" to active voice
so the sentence reads like an instruction; replace the line containing
"<instance-name>" so it says: "For Brev, the Brev CLI creates `<instance-name>`
as both the instance name and SSH alias." Use the terms "<instance-name>" and
"Brev CLI" to locate and update the sentence.
- Line 46: Update the sentence in deploy-to-remote-gpu.mdx that currently reads
"For example, set the browser origin if you will open the dashboard through a
Brev public URL, and raise the first-run readiness budget on cold cloud hosts:"
to present tense; replace "if you will open" with "if you open" so the line
reads "For example, set the browser origin if you open the dashboard through a
Brev public URL, and raise the first-run readiness budget on cold cloud hosts:"
ensuring the example sentence uses present tense.
In `@docs/inference/set-up-sub-agent.mdx`:
- Line 27: The table cell for the `/sandbox/.openclaw/.config-hash` entry
contains two sentences on one line; split them into separate lines in the
Markdown source (one sentence per line) and add an explicit HTML line break (<br
/>) between them so the rendered table still shows both sentences on separate
lines; keep the text referencing `openclaw.json` and the guidance about syncing
after manual edits unchanged.
In `@docs/reference/commands.mdx`:
- Line 255: Replace the incorrect term "API-key mode" with the standardized "API
key mode" in the documentation; locate the sentence containing "API-key mode is
inference-only and does not enable managed tool gateways." and update it to use
"API key mode" to match terminology consistency.
🪄 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: Enterprise
Run ID: 7cd201b5-8e63-44bd-b45a-02dda4882321
📒 Files selected for processing (6)
docs/.docs-skipdocs/deployment/deploy-to-remote-gpu.mdxdocs/inference/set-up-sub-agent.mdxdocs/reference/commands-nemohermes.mdxdocs/reference/commands.mdxdocs/reference/troubleshooting.mdx
💤 Files with no reviewable changes (1)
- docs/.docs-skip
| When at least one sandbox is registered and the named NemoClaw gateway is unreachable, unhealthy, or attached to a different sandbox, the command prints a `gateway: down [state] (reason)` line between the sandbox list and the host-service list. | ||
| The command classifies the failing layer when possible: the named gateway port is not accepting connections, the named gateway is running but not Connected, the active OpenShell gateway points at a different name, or the named gateway is not configured at all. | ||
| It then suggests `openshell gateway start --name nemoclaw` or `$$nemoclaw onboard --resume` to recover. | ||
| It then suggests `$$nemoclaw onboard --resume` or equivalent managed-gateway recovery guidance. |
Contributor
There was a problem hiding this comment.
--resume is too narrow for generic gateway recovery guidance.
Line 1627 suggests $$nemoclaw onboard --resume, but --resume only works when an interrupted resumable onboarding session exists; otherwise it exits with “No resumable onboarding session was found.”
Please include the non-resume path ($$nemoclaw onboard) as the default recovery instruction and keep --resume as conditional.
Suggested doc tweak
-It then suggests `$$nemoclaw onboard --resume` or equivalent managed-gateway recovery guidance.
+It suggests rerunning `$$nemoclaw onboard` to recover managed gateway state.
+If onboarding was interrupted and a resumable session exists, use `$$nemoclaw onboard --resume`.Based on learnings from src/lib/onboard.ts (--resume continues only interrupted onboarding sessions).
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| It then suggests `$$nemoclaw onboard --resume` or equivalent managed-gateway recovery guidance. | |
| It suggests rerunning `$$nemoclaw onboard` to recover managed gateway state. | |
| If onboarding was interrupted and a resumable session exists, use `$$nemoclaw onboard --resume`. |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/reference/commands.mdx` at line 1627, The docs currently recommend only
`$$nemoclaw onboard --resume` but `--resume` only works when an interrupted
resumable onboarding session exists; update the text to recommend the generic
recovery command `$$nemoclaw onboard` as the default recovery path and mention
`--resume` as a conditional option that should only be used when an interrupted
session exists (reflecting the behavior implemented in onboard.ts which only
continues an interrupted onboarding session).
Contributor
PR Review AdvisorFindings: 0 needs attention, 5 worth checking, 0 nice ideas Review findings🛠️ Needs attention
🔎 Worth checking
🌱 Nice ideas
Consider writing more tests for
This is an automated advisory review. A human maintainer must make the final merge decision. |
cv
approved these changes
Jun 11, 2026
This was referenced Jun 11, 2026
This was referenced Jun 12, 2026
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
3 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
Fixes QA-reported documentation drift in the remote GPU deployment, sub-agent setup, command reference, and troubleshooting pages. The updates replace deprecated or removed command paths with the current installer, Docker-driver, and NemoClaw-managed recovery flows.
Related Issue
Fixes #5084
Fixes #3720
Fixes #3685
Fixes #3686
Changes
nemoclaw onboardflow and scopenemoclaw deployas legacy Brev compatibility.kubectl execsub-agent setup examples with Docker-driver sandbox container commands and current config ownership guidance.openshell gateway start,openshell gateway trust, andconfig web-searchreferences from troubleshooting and command references.config getandshieldscommand reference coverage for NemoClaw and NemoHermes, and removed stale docs-skip entries that blocked those shipped commands.Type of Change
Verification
npx prek run --all-filespassesnpm testpassesnpm run docsbuilds without warnings (doc changes only)Notes:
npm run docspassed with 0 errors and one pre-existing Fern contrast warning: light-mode accent color contrast ratio is 2.41:1 and should be at least 3:1.npx prek run --all-fileswas attempted. Formatting, lint, secrets, markdownlint, docs-to-skills, and staged-file commit hooks passed, but the full all-files run failed in unrelated CLI test timeouts and one signal assertion outside this docs change.Signed-off-by: Miyoung Choi miyoungc@nvidia.com
Summary by CodeRabbit
config get,shieldscontrols)