docs: complete post-tag audit fixes#7495
Conversation
Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
|
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 (1)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughThe PR reorganizes network-policy and Deep Agents trace-export documentation into dedicated workflows, updates navigation and route tests, refreshes changelog and reference links, and clarifies platform, model-host, and security documentation. ChangesDocumentation and support updates
Estimated code review effort: 4 (Complex) | ~45 minutes Possibly related PRs
Suggested labels: Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
Code Coverage OverviewLanguages: TypeScript TypeScript / code-coverage/pluginThe overall coverage in commit 53b0263 in the TypeScript / code-coverage/cliThe overall coverage in commit 53b0263 in the Show a code coverage summary of the most impacted files.
Updated |
|
🌿 Preview your docs: https://nvidia-preview-pr-7495.docs.buildwithfern.com/nemoclaw |
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: 1 optional E2E recommendation
This automated review informs maintainers. Warnings and suggestions do not require a response. A maintainer decides whether to merge. |
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
docs/network-policy/set-up-gmail-with-an-app-password.mdx (1)
89-89: 🩺 Stability & Availability | 🔵 Trivial | ⚡ Quick winAdd a
timeoutto the IMAP connection, matching the SMTP example.The SMTP script in this same guide uses
smtplib.SMTP_SSL(..., timeout=30), butimaplib.IMAP4_SSL("imap.gmail.com", 993)here has no timeout. Python'simaplib.IMAP4_SSLsupports an optionaltimeoutkeyword (since 3.9); without it, an unresponsive server can hang the script indefinitely.⏱️ Proposed fix
-with imaplib.IMAP4_SSL("imap.gmail.com", 993) as mailbox: +with imaplib.IMAP4_SSL("imap.gmail.com", 993, timeout=30) as mailbox:🤖 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/network-policy/set-up-gmail-with-an-app-password.mdx` at line 89, Update the IMAP4_SSL connection in the guide to pass a 30-second timeout, matching the existing SMTP_SSL example, while preserving the current Gmail host and port.
🤖 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/network-policy/apply-policy-presets.mdx`:
- Line 107: Update the Commands link target in apply-policy-presets.mdx to use
the generated anchor fragment nemoclaw-name-policy-add without the literal
dollar-sign prefix, while preserving the existing reference path and link text.
---
Nitpick comments:
In `@docs/network-policy/set-up-gmail-with-an-app-password.mdx`:
- Line 89: Update the IMAP4_SSL connection in the guide to pass a 30-second
timeout, matching the existing SMTP_SSL example, while preserving the current
Gmail host and port.
🪄 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: 6a1239ab-7d63-425c-926f-300be8cd2c69
📒 Files selected for processing (35)
ci/platform-matrix.jsondocs/changelog/2026-06-08.mdxdocs/changelog/2026-06-11.mdxdocs/changelog/2026-06-28.mdxdocs/changelog/2026-07-01.mdxdocs/changelog/2026-07-04.mdxdocs/changelog/2026-07-08.mdxdocs/changelog/2026-07-09.mdxdocs/changelog/2026-07-12.mdxdocs/changelog/2026-07-14.mdxdocs/changelog/2026-07-24.mdxdocs/get-started/quickstart-langchain-deepagents-code.mdxdocs/index.ymldocs/inference/set-up-vllm.mdxdocs/monitoring/manage-deepagents-trace-export.mdxdocs/monitoring/set-up-deepagents-trace-export.mdxdocs/monitoring/understand-deepagents-trace-export.mdxdocs/monitoring/verify-deepagents-trace-export.mdxdocs/network-policy/apply-policy-presets.mdxdocs/network-policy/change-baseline-network-policy.mdxdocs/network-policy/configure-raw-tls-passthrough.mdxdocs/network-policy/create-custom-policy-presets.mdxdocs/network-policy/customize-network-policy.mdxdocs/network-policy/explain-network-policy-to-agents.mdxdocs/network-policy/integration-policy-examples.mdxdocs/network-policy/replace-live-network-policy.mdxdocs/network-policy/set-up-gmail-with-an-app-password.mdxdocs/reference/commands.mdxdocs/reference/network-policies.mdxdocs/reference/platform-support.mdxdocs/security/advisory-early-warning.mddocs/security/credential-storage.mdxtest/deepagents-monitoring-published-routes.test.tstest/network-policies-published-routes.test.tstest/policy-roundtrip-docs.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 `@docs/security/advisory-early-warning.md`:
- Around line 150-153: Update the “Reviewed-mapping delay” paragraph to state
that the correlation path reads file-based NVD responses supplied through the
--nvd-records input, rather than fetching NVD records itself. Clarify that the
scheduled workflow will perform the fetch and pass those records to the CLI,
while preserving the existing six-hour cadence and `#7338` sign-off gating.
🪄 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: 6135f105-b11f-4372-b38b-673f8980bbb9
📒 Files selected for processing (2)
docs/get-started/quickstart-langchain-deepagents-code.mdxdocs/security/advisory-early-warning.md
🚧 Files skipped from review as they are similar to previous changes (1)
- docs/get-started/quickstart-langchain-deepagents-code.mdx
Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
<!-- markdownlint-disable MD041 --> ## Summary Adds the canonical pre-tag `## v0.0.95` release entry to `docs/changelog/2026-07-24.mdx`, before the existing v0.0.94 entry. The entry summarizes approved user-visible changes merged since v0.0.94 and excludes internal-only prerequisites. ## Changes - Adds the v0.0.95 summary and detailed bullets for gateway lifecycle, recovery, state transfer, inference compatibility, sandbox security, Discord policy, and E2E evidence. - Links each user-facing theme to the most specific published documentation. - Records the release entry in the shared native changelog used by the OpenClaw, Hermes, and Deep Agents guides. Source summary: - [#7246](#7246), [#7228](#7228), [#7267](#7267), [#7489](#7489), [#7509](#7509), [#7351](#7351), and [#7290](#7290) -> `docs/changelog/2026-07-24.mdx`: Gateway authority, forward teardown and retry, managed recovery, Hermes restart recovery, scoped uninstall, and orphan-aware backup behavior. - [#7344](#7344) and [#7416](#7416) -> `docs/changelog/2026-07-24.mdx`: Atomic SQLite restore and host download verification. - [#7476](#7476), [#7347](#7347), [#7281](#7281), [#7485](#7485), [#7491](#7491), and [#7422](#7422) -> `docs/changelog/2026-07-24.mdx`: Windows Ollama reuse, CDI fallback, bounded OpenRouter connection setup, Nemotron-3 request compatibility, and managed Deep Agents retry and provider-error behavior. - [#6884](#6884), [#7481](#7481), [#6878](#6878), [#7467](#7467), [#7502](#7502), [#7503](#7503), [#7504](#7504), and [#7486](#7486) -> `docs/changelog/2026-07-24.mdx`: Trusted base-image overrides, local rebuild images, runtime validation, config preservation, reviewed package updates, and fewer final-image payload layers. - [#7303](#7303) -> `docs/changelog/2026-07-24.mdx`: Scoped Discord application-command management. - [#7488](#7488), [#7465](#7465), [#7497](#7497), [#7464](#7464), [#7501](#7501), [#7494](#7494), and [#7493](#7493) -> `docs/changelog/2026-07-24.mdx`: Selected-test risk signals, retry cleanup, full root-image validation, direct-main Hermes setup, executed PR-gate evidence, nightly history, and runner wait reporting. - [#7447](#7447) is an internal pinned-runtime prerequisite and is intentionally excluded from canonical supported-integration documentation. - [#7370](#7370) adds maintainer-only advisory reconciliation tooling and does not change supported user behavior. - [#7495](#7495) updates existing documentation and does not add a new v0.0.95 behavior claim. ## 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: `test/changelog-docs.test.ts` validates the dated changelog structure, heading uniqueness, and published links. - [ ] 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-24.mdx`; writing rules, documentation style, factual release meaning, and published links reviewed at exact head `58b02f2bf`. - Agent: Codex documentation writer reviewer <!-- docs-review-head-sha: 58b02f2 --> <!-- docs-review-agents-blob-sha: 9c9b36d --> ## DGX Station Hardware Evidence - [ ] Tested on DGX Station - Tested commit: - Station profile/scenario: - Result: - Supporting evidence: ## 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 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 test/changelog-docs.test.ts` passed 6 tests. - [ ] Applicable broad gate passed — `npm test` for broad runtime/test-harness changes; `npm run check` for repo-wide validation/coverage changes — command/result: - [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) — the build passed with 0 errors and 2 Fern warnings. - [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) --- Signed-off-by: Senthil Ravichandran <senthilr@nvidia.com> <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Added a new v0.0.95 changelog entry above v0.0.94. * Documented improved externally supervised gateway lifecycle ownership. * Improved snapshot restore reliability and SQLite state handling. * Tightened CLI `backup-all` behavior and host artifact verification. * Updated Windows onboarding guidance (including Ollama service reuse and CDI directory fallback). * Noted inference compatibility fixes, deeper agent failure classification, stricter base-image validation, updated Discord bot command permissions, and refined E2E release automation evidence handling. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Signed-off-by: Senthil Ravichandran <senthilr@nvidia.com>
Summary
Completes the v0.0.93 and v0.0.94 post-tag documentation audit.
The change corrects platform guidance and moves oversized Network Policy, Gmail, and Deep Agents trace-export content into focused canonical pages while preserving existing public routes and compatibility anchors.
Changes
Type of Change
Quality Gates
53b026370f4b26e3591560911088b5235e465b4eand returned PASS.Documentation Writer Review
docs-updatedci/platform-matrix.json,docs/reference/platform-support.mdx, anddocs/inference/set-up-vllm.mdxdocs/network-policy/customize-network-policy.mdx,docs/network-policy/integration-policy-examples.mdx, and the seven new focused Network Policy pagesdocs/get-started/quickstart-langchain-deepagents-code.mdxand the four newdocs/monitoring/*deepagents-trace-export.mdxpagesdocs/security/advisory-early-warning.md,docs/security/credential-storage.mdx,docs/reference/commands.mdx, anddocs/reference/network-policies.mdxdocs/index.ymland the migrated changelog links underdocs/changelog/cveId, hermetic--inventory, NVD reconciliation, and the fix(images): backport historical OpenClaw security patches #7276 postmortem, and that the Deep Agents compatibility route remains intact.--nvd-recordsreads previously fetched files and that the planned scheduled workflow owns fetching after Detect public advisories before reviewed ecosystem mappings reach scanners #7338 sign-off.docs/CONTRIBUTING.mdandWRITING.md, including terminology, structure, voice, code samples, variants, navigation, routes, and compatibility anchors.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 unavailablenpx vitest run test/generate-platform-docs.test.ts test/network-policies-published-routes.test.ts test/deepagents-monitoring-published-routes.test.ts test/policy-roundtrip-docs.test.ts test/check-docs-published-routes.test.ts test/check-docs-links.test.tspassed 72 tests.npm run docs, normal hooks, and diff checks passed.npm run docs, normal hooks, and diff checks passed.npm run docs, variant generation, normal hooks, and diff checks passed.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)Result:
npm run docspassed with 0 errors and one pre-existing Fern light-mode accent contrast warning.Signed-off-by: Miyoung Choi miyoungc@nvidia.com
Summary by CodeRabbit