docs(starter-prompt): improve guided installation#6990
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. |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Enterprise Run ID: 📒 Files selected for processing (2)
🚧 Files skipped from review as they are similar to previous changes (2)
📝 WalkthroughWalkthroughThe starter prompt now defines prescriptive onboarding for platform readiness, installation, runtime selection, credential capture, messaging, approvals, and verification. Tests enforce the revised security rules, provider eligibility, placeholders, and documentation references. ChangesStarter prompt onboarding flow
Estimated code review effort: 3 (Moderate) | ~20 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 |
|
🌿 Preview your docs: https://nvidia-preview-pr-6990.docs.buildwithfern.com/nemoclaw |
miyoungc
changed the title
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. |
Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
Code Coverage OverviewLanguages: TypeScript TypeScript / code-coverage/pluginThe overall coverage remains at 96%, unchanged from the TypeScript / code-coverage/cliThe overall coverage in the Show a code coverage summary of the most impacted files.
Updated |
Signed-off-by: San Dang <sdang@nvidia.com>
sandl99
changed the title
Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (1)
docs/resources/starter-prompt.md (1)
189-203: 🗄️ Data Integrity & Integration | 🔵 Trivial | ⚡ Quick winClarify the managed vLLM mapping for DGX Spark and DGX Station. The Spark Express flow intentionally leaves
NEMOCLAW_VLLM_MODELunset, while DGX Station Express pinsnvidia/NVIDIA-Nemotron-3-Ultra-550B-A55B-NVFP4; spell out both cases instead of saying “required Express model.”🤖 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/resources/starter-prompt.md` around lines 189 - 203, Update the “Managed vLLM” entry in the provider mapping to distinguish DGX Spark, where NEMOCLAW_VLLM_MODEL remains unset, from DGX Station, where Express setup pins nvidia/NVIDIA-Nemotron-3-Ultra-550B-A55B-NVFP4. Replace the vague “required Express model” wording with these explicit platform-specific behaviors.
🤖 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/resources/starter-prompt.md`:
- Around line 29-31: Update the Goal section and corresponding messaging
instructions to make messaging in the first sandbox conditional on the selected
agent supporting messaging; preserve the existing Deep Agents exception and
avoid requiring messaging for unsupported agents.
- Around line 94-100: Update the Express installation policy flow so it does not
ask users to choose among policy tiers when the flow always sets
NEMOCLAW_POLICY_TIER=balanced. Clearly state that Balanced is required for
Express and continue using the fixed balanced value; apply this consistently to
both Express paths, including the later policy flow.
---
Nitpick comments:
In `@docs/resources/starter-prompt.md`:
- Around line 189-203: Update the “Managed vLLM” entry in the provider mapping
to distinguish DGX Spark, where NEMOCLAW_VLLM_MODEL remains unset, from DGX
Station, where Express setup pins
nvidia/NVIDIA-Nemotron-3-Ultra-550B-A55B-NVFP4. Replace the vague “required
Express model” wording with these explicit platform-specific behaviors.
🪄 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: af6f6a25-2541-4ac5-890f-50d70a86c0e3
📒 Files selected for processing (2)
docs/resources/starter-prompt.mdtest/starter-prompt-docs.test.ts
Signed-off-by: Carlos Villela <cvillela@nvidia.com>
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
docs/resources/starter-prompt.md (1)
164-179: 🔒 Security & Privacy | 🟠 Major | ⚡ Quick winAdd an explicit SHA-256 check for the helper before execution.
The prompt should tell the agent to hash both downloaded files and compare them to the pinned digests before running the helper. The helper already checks the form digest, but it does not protect its own bytes, so a tampered helper could still run first.🤖 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/resources/starter-prompt.md` around lines 164 - 179, Update the instructions around the helper and form trust boundary to explicitly require computing the SHA-256 digest of both downloaded files and comparing each against its pinned digest before executing the helper. Require stopping and deleting the temporary files if either check fails, ensuring the helper itself is verified before it runs.Source: MCP tools
🤖 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.
Outside diff comments:
In `@docs/resources/starter-prompt.md`:
- Around line 164-179: Update the instructions around the helper and form trust
boundary to explicitly require computing the SHA-256 digest of both downloaded
files and comparing each against its pinned digest before executing the helper.
Require stopping and deleting the temporary files if either check fails,
ensuring the helper itself is verified before it runs.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: 3755e4f4-e0cc-47ee-a7ae-2fdccd522f7b
📒 Files selected for processing (2)
docs/resources/starter-prompt.mdtest/starter-prompt-docs.test.ts
🚧 Files skipped from review as they are similar to previous changes (1)
- test/starter-prompt-docs.test.ts
Signed-off-by: Carlos Villela <cvillela@nvidia.com>
cv
left a comment
cv
left a comment
There was a problem hiding this comment.
Reviewed exact head e12e48f against current base c1bda80. The starter prompt now matches existing supported agent/Express behavior, explicitly verifies both pinned credential-helper artifacts before execution, and has focused contract coverage. All current checks are green, both advisor lanes and CodeRabbit have no remaining actionable findings, the docs build passed, and DCO/Verified gates pass.
3 participants
Summary
The copyable starter prompt now guides a non-technical user through an end-to-end NemoClaw installation one question at a time, without leaving interactive terminal menus running or exposing credentials. It retains the DGX Station Express mapping while adding complete platform readiness, provider, messaging, approval, sudo, Ollama, credential-helper, and documentation-discovery guidance.
Changes
docs/resources/starter-prompt.md: Reflect DGX Station GB300 firmware detection in the starter decision flow.docs/resources/starter-prompt.md: Preserve the merged Station Nemotron Ultra Express selectors and explicit non-interactive equivalent.Type of Change
Quality Gates
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 unavailablenpx vitest run test/starter-prompt-docs.test.ts test/changelog-docs.test.tspassed 18 tests in 2 files.npm testfor broad runtime/test-harness changes;npm run checkfor repo-wide validation/coverage changes — not run for this documentation-only change.npm run docsbuilds without warnings (doc changes only) — passed with zero errors and two existing Fern warnings.Signed-off-by: Miyoung Choi miyoungc@nvidia.com
Signed-off-by: San Dang sdang@nvidia.com
Summary by CodeRabbit
Documentation
Tests
Signed-off-by: Carlos Villela cvillela@nvidia.com