docs: address post-tag audit findings and adjust DORI install guidance - #7947
Conversation
|
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:
📝 WalkthroughWalkthroughThis PR revises DORI routing guidance, adds a managed Deep Agents Code runtime guide, updates related references and navigation, adds troubleshooting content, and validates published documentation routes. ChangesDORI routing policy
Deep Agents documentation
Documentation navigation and references
Estimated code review effort: 3 (Moderate) | ~25 minutes Possibly related PRs
Suggested labels: Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
|
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. |
Code Coverage OverviewLanguages: TypeScript TypeScript / code-coverage/pluginThe overall coverage in commit d65f179 in the TypeScript / code-coverage/cliThe overall coverage in commit d65f179 in the Show a code coverage summary of the most impacted files.
Updated |
|
🌿 Preview your docs: https://nvidia-preview-pr-7947.docs.buildwithfern.com/nemoclaw |
PR Review Advisor — No blocking findings reportedAdvisor assessment: No blocking advisor findings reported Model lanes
Second-opinion E2E selections are advisory. They do not change the primary assessment or E2E / PR Gate. E2E guidanceAdvisory only. E2E / PR Gate selects and runs jobs independently. Recommended E2E: None This automated review informs maintainers. Warnings and suggestions do not require a response. A maintainer decides whether to merge. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
test/check-docs-published-routes.test.ts (1)
473-476: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winPrefer public-boundary assertions over raw source-text checks.
This test already validates link resolution behaviorally via
findBrokenPublishedRoutes(quickstartSource, index)on line 472. The subsequent.split('<a id="use-the-harness"></a>')and.toContain("[Run Deep Agents Code](...)")checks lock the test to exact source markup/phrasing rather than resolved outcomes, so a harmless rewording of the link text or anchor placement would fail the test even though the actual route still resolves correctly.As per path instructions, "Prefer observable outcomes through the public boundary over source-text, private-shape, or mock-call assertions." Consider expressing the link-target check via
extractMarkdownLinks/resolvePublishedRoute(checking the resolved target instead of the literal markdown string) where practical.♻️ Example of asserting via the resolved target instead of literal text
- expect(quickstart).toContain( - "[Run Deep Agents Code](../manage-sandboxes/operate-sandboxes/run-deep-agents-code)", - ); + const link = extractMarkdownLinks(quickstart).find((l) => + l.target.includes("run-deep-agents-code"), + ); + expect(link).toBeDefined(); + expect( + resolvePublishedRoute("/user-guide/deepagents/get-started/quickstart", link!.target), + ).toBe("/user-guide/deepagents/manage-sandboxes/operate-sandboxes/run-deep-agents-code");🤖 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 `@test/check-docs-published-routes.test.ts` around lines 473 - 476, Replace the raw quickstart source assertions in the test with public-boundary checks using extractMarkdownLinks and resolvePublishedRoute, or the existing findBrokenPublishedRoutes flow, to verify that the relevant link resolves to the expected published route. Remove dependence on the exact anchor markup and link text while preserving validation of the intended target.Source: Path instructions
🤖 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/AGENTS.md`:
- Around line 78-80: Update the DORI routing instructions in the documentation
workflow so they are only required when the current host has the verified NVIDIA
documentation Skill Library; otherwise, allow agents to use the existing
non-blocking fallback without attempting DORI or prompting for setup. Adjust the
routing guidance around the NVIDIA DORI Routing reference and fallback to make
this conditional behavior explicit.
---
Nitpick comments:
In `@test/check-docs-published-routes.test.ts`:
- Around line 473-476: Replace the raw quickstart source assertions in the test
with public-boundary checks using extractMarkdownLinks and
resolvePublishedRoute, or the existing findBrokenPublishedRoutes flow, to verify
that the relevant link resolves to the expected published route. Remove
dependence on the exact anchor markup and link text while preserving validation
of the intended target.
🪄 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: 6bea6ad6-6c51-46c6-8dd9-1d90915bfe13
📒 Files selected for processing (12)
.gitignoreAGENTS.mddocs/AGENTS.mddocs/DORI_SETUP.mddocs/get-started/quickstart-langchain-deepagents-code.mdxdocs/index.ymldocs/manage-sandboxes/run-deep-agents-code.mdxdocs/reference/commands.mdxdocs/reference/troubleshooting.mdxdocs/resources/engineer-agentic-documentation.mdxdocs/security/hermes-0.19.0-dependency-review.mdtest/check-docs-published-routes.test.ts
Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
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 `@test/check-docs-published-routes.test.ts`:
- Around line 468-479: Update the assertions around findBrokenPublishedRoutes
and the quickstart link checks to use the rendered published-page body from the
same rendering path as findBrokenPublishedRoutes, rather than raw MDX sources.
Verify the runtime route and use-the-harness anchor through observable rendered
Deep Agents route content, preserving the existing published-route expectations.
🪄 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: 1600e187-8791-43f6-b77e-fc9438b26d57
📒 Files selected for processing (2)
docs/AGENTS.mdtest/check-docs-published-routes.test.ts
Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
miyoungc
changed the title
senthilr-nv
left a comment
senthilr-nv
left a comment
There was a problem hiding this comment.
Product-scope verdict: PASS. This PR reorganizes and clarifies existing maintained NemoClaw documentation; it does not establish a new supported integration or solution surface.
Changes requested: move or duplicate the headless automation warning before the first dcode -n command. The current ordering presents a mutating automation command before disclosing that headless mode has no approval UI and automatically approves non-shell tools, including file writes and edits. This violates the high-risk procedure contract and can cause unreviewed workspace mutations.
After the correction, rerun the affected route/docs checks and refresh the documentation-writer receipt for the new exact head. GitHub currently reports BLOCKED separately because review is required and 12 checks are pending.
Signed-off-by: Senthil Ravichandran <senthilr@nvidia.com>
|
Addressed the headless approval-boundary finding in verified commit The Deep Agents guide now places a warning before the first Exact-head validation: focused Vitest passed 6 files / 88 tests, |
senthilr-nv
left a comment
senthilr-nv
left a comment
There was a problem hiding this comment.
Approved at exact head d65f179. Product scope: PASS. The headless approval-boundary finding is addressed, focused tests and docs validation pass, independent documentation-writer review passes, all review threads are resolved, and automated review reports no findings.
<!-- markdownlint-disable MD041 --> ## Summary Adds the canonical dated changelog entry for `v0.0.100` so the maintainer release plan can verify the pre-tag documentation prerequisite. The entry summarizes the user-facing changes merged since `v0.0.99` and links to the relevant guides. ## Changes - Add `docs/changelog/2026-07-31.mdx` with the exact `## v0.0.100` heading. - Cover restored OpenClaw pairing, transactional replacement, Deep Agents Code, onboarding recovery, lifecycle cleanup, Hermes builds, host provenance, documentation, and trusted E2E evidence. - Distinguish active Docker and Kubernetes runtime-bundle enforcement from the still-inactive managed shared-state transaction foundation. ## Source Coverage The release entry maps the doc-impacting merged PRs in the `v0.0.99..main` release range to `docs/changelog/2026-07-31.mdx`: #8021, #8024, #7973, #8028, #7947, #7788, #7884, #8023, #7969, #8020, #7989, #8000, #7907, #7942, #7567, #8013, #7955, #8017, #8014, #8015, #7629, #7644, #7821, #7971, and #7991. PR #7974 was reviewed after the final rebase and excluded because it changes internal maintainer-skill attribution policy and tests only; it does not change a user-facing product or documentation surface. ## Type of Change - [ ] Code change (feature, bug fix, or refactor) - [ ] Code change with doc updates - [x] Doc only (prose changes, no code sample modifications) - [ ] Doc only (includes code sample changes) ## Quality Gates - [ ] Tests added or updated for changed behavior - [x] Existing tests cover changed behavior — justification: the changelog contract test validates the dated entry, version heading, SPDX form, and route constraints. - [ ] Tests not applicable — justification: - [x] Docs updated for user-facing behavior changes - [ ] Docs not applicable — justification: - [ ] 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: - [ ] Non-success, skipped, or missing CI check accepted by maintainer — check name, approval link, and follow-up issue: ## Documentation Writer Review - [x] Documentation writer subagent reviewed the completed changes - Result: `docs-updated` - Evidence: `docs/changelog/2026-07-31.mdx`; exact-head review passed for `6093f44f`; writing rules and documentation style reviewed; `npx vitest run test/changelog-docs.test.ts` passed 6/6; `npm run docs` passed with zero Fern errors and two generic Fern upgrade notices. - Agent: Codex Desktop <!-- docs-review-head-sha: 6093f44 --> <!-- docs-review-agents-blob-sha: 3dd7c24 --> ## DGX Station Hardware Evidence - [ ] Tested on DGX Station - Tested commit: Not applicable; no DGX Station host script changed. - Station profile/scenario: Not applicable. - Result: Not applicable. - Supporting evidence: Not applicable. ## Verification - [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 validate:pr` passed after refreshing `origin/main` 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 test/changelog-docs.test.ts` passed 6/6 at `6093f44f`. - [ ] 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 a dated prose-only release entry. - [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) — validation passed with zero errors; Fern emitted two generic upgrade notices. - [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) — the changelog entry has the required parser-safe MDX SPDX header; dated changelog entries intentionally do not use page frontmatter. --- Signed-off-by: Senthil Ravichandran <senthilr@nvidia.com> <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Added release notes for v0.0.100. * Documented improvements to restore pairing, sandbox replacement, onboarding recovery, lifecycle cleanup, runtime handling, build support, host readiness, and end-to-end validation. <!-- end of auto-generated comment: release notes by coderabbit.ai --> Signed-off-by: Senthil Ravichandran <senthilr@nvidia.com>
2 participants
Summary
Documents the user-facing changes identified by the
v0.0.96..v0.0.97post-tag audit and publishes the existing agentic-documentation guide in each documentation variant. Replaces repository-local DORI contributor classification state with current-host capability detection so fresh worktrees do not repeatedly prompt users. Links the internal Skill Library and Template Library for explicit setup requests. Adds the boundedv0.0.98..v0.0.99audit follow-ups for changelog accuracy, memory-search prerequisites, two-DGX Station route verification, and prose clarity.Changes
invalid_docker_hostrecovery procedure from fix(onboard): report an invalid DOCKER_HOST instead of a docker-group remediation #7775 and thesandbox_recovery_failedstate from fix(status): recover visible post-reboot sandbox #7848.docs/resources/engineer-agentic-documentation.mdxpage under Resources in all guide variants and align its route description with the live TOC.v0.0.99changelog attribution for the focused runtime identity, two-DGX Station vLLM, and memory search pages./api/tagsacceptance criterion for memory search.reachablestatus.sandbox_recovery_failedguidance for an unproven agent delivery chain and keep Docker readiness failures under their separate preflight layers.Type of Change
Quality Gates
Documentation Writer Review
docs-updated.gitignore,AGENTS.md,docs/AGENTS.md,docs/DORI_SETUP.md,docs/index.yml,docs/changelog/2026-07-30.mdx,docs/configure-agents/configure-memory-search.mdx,docs/get-started/quickstart-langchain-deepagents-code.mdx,docs/inference/set-up-vllm-on-two-dgx-stations.mdx,docs/manage-sandboxes/run-deep-agents-code.mdx,docs/reference/commands.mdx,docs/reference/configure-runtime-identity.mdx,docs/reference/troubleshooting.mdx,docs/resources/engineer-agentic-documentation.mdx,docs/security/hermes-0.19.0-dependency-review.md,scripts/check-docs-published-routes.mts, andtest/check-docs-published-routes.test.ts. The independent reviewer checked product scope, writing rules, documentation style, terminology, structure, voice, code samples, prerequisites, risks, navigation, routes, guide variants, and source-backed technical claims. The headless mutation warning now precedes the firstdcode -ncommand. Plugin build passed; the focused six-file Vitest suite passed 88 tests;npm run docspassed with 65 guarded routes and 0 Fern errors. Final result: PASS ond65f1793.DGX Station Hardware Evidence
Verification
Signed-off-by:line and every commit appears asVerifiedin GitHubpre-commit,commit-msg, andpre-pushhooks passed, ornpm run validate:prpassed after refreshingorigin/mainwhen hooks were skipped or unavailablenpx vitest run test/changelog-docs.test.ts test/station-doc-ownership.test.ts test/inference-options-docs.test.ts test/check-docs-links.test.ts test/sync-agent-variant-docs.test.tspassed 58 tests on the reviewed head.npm testfor broad runtime/test-harness changes;npm run checkfor repo-wide validation/coverage changes — not applicable because this PR does not change runtime behavior or repository-wide validation.npm run docsbuilds without warnings (doc changes only) — it passed with 0 errors and the existing Fern CLI upgrade warning.Signed-off-by: Miyoung Choi miyoungc@nvidia.com
Summary by CodeRabbit
Documentation
Tests