docs: correct inference CLI references - #7321
Closed
laitingsheng wants to merge 5 commits into
Closed
Conversation
- Surface the `agents apply` reference in the declarative manifest guide. - Scope the Deep Agents recreation heading to its variant. - Correct the shields sandbox-argument prose in switch-providers. - Name `NEMOCLAW_AGENT` and `NEMOCLAW_INSTALL_TAG` in quickstart and the starter prompt. Signed-off-by: Tinson Lai <tinsonl@nvidia.com>
Contributor
📝 WalkthroughWalkthroughDocumentation updates add installation variables, clarify manifest application, correct named-sandbox provider commands, and constrain the Deep Agents recreation heading to its variant block. ChangesDocumentation guidance
Estimated code review effort: 1 (Trivial) | ~5 minutes Possibly related PRs
Suggested labels: Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Comment |
laitingsheng
added
NV QA
![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
🤖 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/inference/declarative-agents-manifest.mdx`:
- Line 172: Update the `nemoclaw <name> agents apply` command in the roster
reconciliation guidance to include the required `-f <agents.yaml>` manifest
argument, matching the usage shown near line 179 and the command implementation.
🪄 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: 68fdbe37-13e9-4838-95a9-ecb79d1b0c9c
📒 Files selected for processing (4)
docs/get-started/quickstart.mdxdocs/inference/declarative-agents-manifest.mdxdocs/inference/switch-providers.mdxdocs/resources/starter-prompt.md
Contributor
|
🌿 Preview your docs: https://nvidia-preview-pr-7321.docs.buildwithfern.com/nemoclaw |
Contributor
PR Review Advisor — InformationalAdvisor assessment: Informational / high confidence Model lanes
Nemotron output stays in workflow artifacts and does not change the assessment above. E2E guidanceAdvisory only. E2E / PR Gate selects and runs jobs independently. Recommended E2E: None 1 optional E2E recommendation
This automated review informs maintainers. Warnings and suggestions do not require a response. A maintainer decides whether to merge. |
The job's shallow, single-SHA checkout never created a local origin/main ref, so the repository-checks merge-base lookup failed for every docs-only PR. Deepen the shallow boundary by one generation and name the base commit so the existing check can resolve it. Signed-off-by: Tinson Lai <tinsonl@nvidia.com>
Signed-off-by: Tinson Lai <tinsonl@nvidia.com>
Contributor
Code Coverage OverviewLanguages: TypeScript TypeScript / code-coverage/pluginThe overall coverage in commit 0f4461c in the TypeScript / code-coverage/cliThe overall coverage in commit 0f4461c in the Show a code coverage summary of the most impacted files.
Updated |
This reverts commit 3efdaed. Fixing this requires the whole PR to leave the docs-only check path, which currently fails on an unrelated, pre-existing reviewed-npm-audit finding. Tracking that fix separately. Signed-off-by: Tinson Lai <tinsonl@nvidia.com>
22 tasks
Collaborator
|
Thanks for addressing these QA findings. #7311 is now fully resolved by merged PR #7328, including the install-variable guidance, install-ref/tag precedence, coding-agent-neutral sandbox guidance, and regression coverage. Please rebase on the latest
Suggested title: |
…sistency Signed-off-by: Tinson Lai <tinsonl@nvidia.com> # Conflicts: # docs/get-started/quickstart.mdx # docs/resources/starter-prompt.md
laitingsheng
changed the title
cv
added a commit
that referenced
this pull request
Jul 23, 2026
<!-- markdownlint-disable MD041 --> ## Summary Corrects inference documentation so manifest iteration names the implemented `agents apply -f` command, named-sandbox syntax matches the CLI, and the Deep Agents recreation heading appears only in the Deep Agents guide. Adds variant-rendering regression coverage for both QA defects. ## Related Issue Fixes #7308 Fixes #7309 Supersedes #7321 ## Changes - Document `nemoclaw <name> agents apply -f <agents.yaml>` in the manifest iteration guidance without adding the nonexistent `agents show` command. - Distinguish positional sandbox names for `shields` from `inference set --sandbox <name>`. - Keep the Deep Agents recreation heading inside the `deepagents` variant block. - Add focused regression assertions for the affected prose and generated agent variants. ## Type of Change - [ ] Code change (feature, bug fix, or refactor) - [x] Code change with doc updates - [ ] Doc only (prose changes, no code sample modifications) - [ ] Doc only (includes code sample changes) ## Quality Gates <!-- Check one tests line and one docs line. Check other lines when applicable. Add every requested justification or approval reference. --> - [x] Tests added or updated for changed behavior - [ ] Existing tests cover changed behavior — justification: - [ ] Tests not applicable — justification: - [x] Docs updated for user-facing behavior changes - [ ] Docs not applicable — justification: - [x] Sensitive paths changed (security, policy, credentials, preflight, onboarding, inference, runner, sandbox, or messaging) - [x] Sensitive-path review completed or maintainer-approved waiver recorded — reviewer/approval link/justification: Miyoung Choi reviewed the existing inference command syntax and generated variant behavior; no inference runtime changed. - [ ] Non-success, skipped, or missing CI check accepted by maintainer — check name, approval link, and follow-up issue: ## Documentation Writer Review <!-- Required for code and documentation changes after the changes and applicable validation are complete. Keep one review checkbox and one instance of each visible or hidden field. For Evidence, list changed documentation paths. For documentation-only changes, also state that the writing rules and documentation style were reviewed. For other results, explain why no documentation change is needed or why the review is blocked. For Agent, use a consistent product and surface name, such as Codex Desktop, Codex CLI, Claude Code, or Cursor. Record this PR number. After committing all review changes, put `git rev-parse --short HEAD` and `git rev-parse --short HEAD:AGENTS.md` in the hidden metadata below. Rerun the review and refresh that metadata after any new commit. This receipt is advisory during the data-collection pilot. --> - [x] Documentation writer subagent reviewed the completed changes - Result: `docs-updated` - Evidence: Reviewed `docs/inference/declarative-agents-manifest.mdx` and `docs/inference/switch-providers.mdx` for terminology, structure, voice, and code-sample presentation. The focused 15-test Vitest run and documentation build passed. - Agent: Codex Desktop - PR: #7405 <!-- docs-review-head-sha: c06e315 --> <!-- docs-review-agents-blob-sha: 560ff38 --> ## DGX Station Hardware Evidence <!-- Required only when scripts/prepare-dgx-station-host.sh changes. Maintainers must review the linked evidence before approving or merging. This is human-reviewed evidence, not authenticated hardware provenance. Exceptional bypasses use existing repository governance and must be documented on the PR. --> - [ ] Tested on DGX Station - Tested commit: - Station profile/scenario: - Result: - Supporting evidence: ## Verification <!-- Check each applicable item only when supported by the requested evidence. Run targeted tests once per relevant change set and rerun after later edits or hook autofixes that can affect that behavior. Do not rerun hook-covered checks. --> - [x] PR description includes a `Signed-off-by:` line and every commit appears as `Verified` in GitHub - [x] Normal `pre-commit`, `commit-msg`, and `pre-push` hooks passed, or `npm run check:diff` passed when hooks were skipped or unavailable - [x] Targeted behavior tests pass for the current change set, or tests are marked not applicable above — command/result or justification: `npx vitest run --project integration test/agent-variant-docs.test.ts` passed (1 file, 15 tests). - [ ] Applicable broad gate passed — `npm test` for broad runtime/test-harness changes; `npm run check` for repo-wide validation/coverage changes — command/result: not applicable; this change updates two documentation pages and focused regression assertions. - [x] Quality Gates section completed with required justifications or waivers - [x] No secrets, API keys, or credentials committed - [ ] `npm run docs` builds without warnings (doc changes only) — passed with 0 errors and 1 existing light-mode accent contrast warning unrelated to this diff. - [x] Doc pages follow the [style guide](https://github.com/NVIDIA/NemoClaw/blob/main/docs/CONTRIBUTING.md) (doc changes only) - [ ] New doc pages include SPDX header and frontmatter (new pages only) — not applicable; no pages were added. --- <!-- DCO sign-off is required in this PR description, and every commit must appear as Verified in GitHub. Run: git config user.name && git config user.email --> Signed-off-by: Miyoung Choi <miyoungc@nvidia.com> <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Added guidance for reconciling agent rosters from an `agents.yaml` manifest. * Clarified sandbox selection syntax when switching inference providers. * Improved the placement of Deep Agents sandbox recreation instructions. * **Tests** * Added coverage to verify manifest iteration and provider-switching documentation across supported agent variants. <!-- end of auto-generated comment: release notes by coderabbit.ai --> Signed-off-by: Miyoung Choi <miyoungc@nvidia.com> Co-authored-by: Carlos Villela <cvillela@nvidia.com>
Collaborator
|
Closing as superseded by #7405 |
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
4 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
Fix two NV QA documentation inconsistencies in the inference guides. The declarative multi-agent manifest guide now surfaces the
agents applysubcommand, and the Switch Providers page scopes the Deep Agents recreation heading to its variant and describes the correctshieldssandbox argument.Related Issue
Fixes #7308
Fixes #7309
Changes
docs/inference/declarative-agents-manifest.mdx: surfacenemoclaw <name> agents applyin the Iterating section with a link to Apply to an Existing Sandbox, so the subcommand text matches the code block. The non-existentagents showis deliberately not added.docs/inference/switch-providers.mdx: move the Recreate a Deep Agents Sandbox heading inside thedeepagentsAgentOnlyblock so it no longer renders empty on the OpenClaw and Hermes variants, and reword the runtime-switch prose to state thatshieldstakes a positional sandbox name whileinference settakes--sandbox.Type of Change
Quality Gates
npm run docs(fern check plus the agent-variant and route drift checks) validates the inference edits. No runtime behavior changed.DGX Station Hardware Evidence
Verification
Signed-off-by:line and every commit appears asVerifiedin GitHubpre-commit,commit-msg, andpre-pushhooks passed, ornpm run check:diffpassed when hooks were skipped or unavailablenpm run docs→ fern check 0 errors (2 pre-existing warnings), agent-variant and route drift checks pass.npm testfor broad runtime/test-harness changes;npm run checkfor repo-wide validation/coverage changes — command/result:npm run docsbuilds without warnings (doc changes only) — fern check reports 0 errors; the 2 warnings are pre-existing and unrelated to this change.Signed-off-by: Tinson Lai tinsonl@nvidia.com