docs(security): replace deprecated Deep Agents deploy command - #6604
Conversation
|
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 (1)
📝 WalkthroughWalkthroughUpdates credential-storage documentation to describe ChangesCredential onboarding documentation
Estimated code review effort: 1 (Trivial) | ~3 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
|
🌿 Preview your docs: https://nvidia-preview-pr-6604.docs.buildwithfern.com/nemoclaw |
E2E Advisor RecommendationRequired E2E: None Full advisor summaryE2E Recommendation AdvisorBase: Required E2E
Optional E2E
New E2E recommendations
|
E2E Target RecommendationRequired E2E targets: None Full E2E target advisor summaryE2E Target AdvisorFailed: Target advisor SDK provider error: session: 429 status code (no body); turn: target-analysis: 429 status code (no body) |
PR Review Advisor — No blocking findingsMerge posture: No blocking advisor findings This is an automated, non-binding review; it still expects maintainers and agents to respond to each required or warning item. Treat suggestions as current-PR improvements when they touch changed code; defer only with maintainer rationale or a linked follow-up. A human maintainer must make the final merge decision. |
PR Review Advisor (Nemotron Ultra) — No blocking findingsMerge posture: No blocking advisor findings This is an automated, non-binding review; it still expects maintainers and agents to respond to each required or warning item. Treat suggestions as current-PR improvements when they touch changed code; defer only with maintainer rationale or a linked follow-up. A human maintainer must make the final merge decision. |
…#6604) <!-- markdownlint-disable MD041 --> ## Summary <!-- 1-3 sentences: what this PR does and why. --> This PR replaces the deprecated Deep Agents `deploy` example in the shared credential-storage page with the supported `onboard --name` flow. It also removes Brev-only credential-forwarding claims that do not apply to current onboarding. ## Related Issue <!-- Fixes #NNN or Closes #NNN. Remove this section if none. --> Closes NVIDIA#6546. ## Changes <!-- Bullet list of key changes. --> - Rename the deprecated deploy section to describe current onboarding behavior. - Render `nemo-deepagents onboard --name my-instance` in the generated Deep Agents guide. - Remove obsolete `HF_TOKEN`, Telegram, and Brev forwarding guidance from the example. ## Type of Change - [ ] Code change (feature, bug fix, or refactor) - [ ] Code change with doc updates - [ ] Doc only (prose changes, no code sample modifications) - [x] Doc only (includes code sample changes) ## Quality Gates <!-- Check exactly one tests line and one docs line. Check other lines when applicable. Add every requested justification or approval reference. --> - [ ] Tests added or updated for changed behavior - [x] Existing tests cover changed behavior — justification: the shared-agent variant and copyable-command tests cover placeholder rendering and fenced command structure. - [ ] 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) - [ ] Sensitive-path review completed or maintainer-approved waiver recorded — reviewer/approval link/justification: Pending maintainer review of this docs-only credential guidance correction. - [ ] Non-success, skipped, or missing CI check accepted by maintainer — check name, approval link, and follow-up issue: ## 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 the tested behavior. Do not rerun hook-covered checks. --> - [x] PR description includes the DCO sign-off declaration 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/sync-agent-variant-docs.test.ts test/docs-copyable-command-blocks.test.ts` (5 tests passed). - [ ] 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 to this focused docs-only change. - [ ] Quality Gates section completed with required justifications or waivers — pending sensitive-path review of the credential guidance. - [x] No secrets, API keys, or credentials committed - [ ] `npm run docs` builds without warnings (doc changes only) — command passed with the repository's existing light-mode accent contrast warning. - [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) --- <!-- 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** * Updated credential storage guidance to describe onboarding behavior for credentials read from the host environment. * Added an example showing how to pass an environment-based API key during onboarding. * Removed outdated deploy-specific instructions from the affected section. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
3 participants
Summary
This PR replaces the deprecated Deep Agents
deployexample in the shared credential-storage page with the supportedonboard --nameflow.It also removes Brev-only credential-forwarding claims that do not apply to current onboarding.
Related Issue
Closes #6546.
Changes
nemo-deepagents onboard --name my-instancein the generated Deep Agents guide.HF_TOKEN, Telegram, and Brev forwarding guidance from the example.Type of Change
Quality Gates
Verification
Verifiedin GitHubpre-commit,commit-msg, andpre-pushhooks passed, ornpm run check:diffpassed when hooks were skipped or unavailablenpx vitest run --project integration test/sync-agent-variant-docs.test.ts test/docs-copyable-command-blocks.test.ts(5 tests passed).npm testfor broad runtime/test-harness changes;npm run checkfor repo-wide validation/coverage changes — command/result: Not applicable to this focused docs-only change.npm run docsbuilds without warnings (doc changes only) — command passed with the repository's existing light-mode accent contrast warning.Signed-off-by: Miyoung Choi miyoungc@nvidia.com
Summary by CodeRabbit