docs: complete v0.0.91 audit follow-ups - #7389
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 (1)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughThe changes clarify rebuild safety and recovery behavior, add base-image requirements to the changelog, and extend prerequisite redirects and validation for Markdown and MDX routes. ChangesRebuild guidance
Prerequisite redirects
Estimated code review effort: 2 (Simple) | ~10 minutes Possibly related PRs
Suggested labels: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Comment |
Code Coverage OverviewLanguages: TypeScript TypeScript / code-coverage/pluginThe overall coverage in commit 169b914 in the TypeScript / code-coverage/cliThe overall coverage in commit 169b914 in the Show a code coverage summary of the most impacted files.
Updated |
|
🌿 Preview your docs: https://nvidia-preview-pr-7389.docs.buildwithfern.com/nemoclaw |
There was a problem hiding this comment.
🧹 Nitpick comments (1)
test/station-doc-ownership.test.ts (1)
138-141: 🎯 Functional Correctness | 🔵 Trivial | 🏗️ Heavy liftAssert redirect behavior instead of raw YAML text.
This substring check can pass for a duplicate or shadowed rule without proving that Fern resolves the route correctly. Exercise the published-route resolver (for example, the logic used by
scripts/check-docs-published-routes.mts) for the suffix matrix.🤖 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/station-doc-ownership.test.ts` around lines 138 - 141, The redirect test around the suffix matrix currently checks raw YAML text instead of resolved routing behavior. Replace the redirects substring assertion in station-doc ownership tests with the published-route resolver used by check-docs-published-routes, and assert each suffix resolves from the legacy prerequisite route to the expected additional-setup destination, preserving the existing suffix-to-destination mapping.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.
Nitpick comments:
In `@test/station-doc-ownership.test.ts`:
- Around line 138-141: The redirect test around the suffix matrix currently
checks raw YAML text instead of resolved routing behavior. Replace the redirects
substring assertion in station-doc ownership tests with the published-route
resolver used by check-docs-published-routes, and assert each suffix resolves
from the legacy prerequisite route to the expected additional-setup destination,
preserving the existing suffix-to-destination mapping.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: 6ffb4692-c4c0-4280-8ccc-9a9f4523ba0b
📒 Files selected for processing (4)
docs/changelog/2026-07-22.mdxdocs/manage-sandboxes/recover-rebuild-sandboxes.mdxfern/docs.ymltest/station-doc-ownership.test.ts
PR Review Advisor — InformationalAdvisor assessment: Informational / low 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 This automated review informs maintainers. Warnings and suggestions do not require a response. A maintainer decides whether to merge. |
|
Addressed the redirect-test review finding in 3e548e0. The test now parses Fern redirects, rejects duplicate source mappings, and asserts exact destinations. The published-route checker also validates Additional Setup destinations. Focused route tests and |
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 `@scripts/check-docs-published-routes.mts`:
- Line 292: Update the validation comment near the guarded redirect checks to
include the Release Notes route group alongside the existing segments, or
replace the list with a generic description of guarded redirect destinations so
it accurately reflects the 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: cc226bea-630a-4629-b18a-67673c8e4f95
📒 Files selected for processing (2)
scripts/check-docs-published-routes.mtstest/station-doc-ownership.test.ts
|
Addressed PR Review Advisor warning PRA-1 in 000311d. The route-checker suite now includes a negative Additional Setup fixture and rejects an unpublished destination. |
|
Resolved the remaining CodeRabbit documentation nit in 169b914 by making the redirect-validation comment accurately describe all guarded destinations. Focused route validation remains green (25/25), and commit/pre-push hooks passed. |
senthilr-nv
left a comment
There was a problem hiding this comment.
Reviewed at 169b914. No blocking findings. The documentation matches the merged rebuild and base-image behavior; the legacy Markdown/MDX redirects and route validation are covered. Focused docs tests (34/34) and npm run docs pass locally, all required checks pass, commits are verified, and review threads are resolved.
<!-- markdownlint-disable MD041 --> ## Summary Adds the canonical dated `## v0.0.93` release entry to `docs/changelog/2026-07-23.mdx`. The entry records user-visible behavior, release validation, and documentation controls merged after `v0.0.92`, while preserving the pending DGX OS `7.6.x` Station Express qualification caveat. ## Changes - Adds the parser-safe dated release entry with a summary, grouped details, and published-route links. - Reconciles the `v0.0.92..origin/main` commit range with merged `v0.0.93` PRs. - Records that no-OTA DGX OS `7.6.x` passed bounded host preflight, while full Station Express end-to-end qualification remains pending. - Leaves existing product pages unchanged because the source PRs already document their supported behavior. ### Source summary - #7285 -> `docs/changelog/2026-07-23.mdx`: Records the existing-vLLM ownership choice and resumable Station handoff. - #7419 -> `docs/changelog/2026-07-23.mdx`: Records bounded no-OTA DGX OS `7.6.x` recognition and its pending end-to-end qualification. - #7268 -> `docs/changelog/2026-07-23.mdx`: Records optional Hugging Face authentication, output sanitization, and resumable HTTP `429` recovery. - #7442 -> `docs/changelog/2026-07-23.mdx`: Records clean SIGINT handling at hidden credential prompts. - #7299 -> `docs/changelog/2026-07-23.mdx`: Records Intel macOS rejection before ref resolution or network work. - #7296 -> `docs/changelog/2026-07-23.mdx`: Records the DGX Spark non-interactive local-vLLM selection order. - #7342 -> `docs/changelog/2026-07-23.mdx`: Records delegated protected E2E approvals in the grouped release-validation bullet. - #7373 -> `docs/changelog/2026-07-23.mdx`: Records base-image publication gating before final-main fanout. - #7388 -> `docs/changelog/2026-07-23.mdx`: Records semantic phase runtime summaries. - #7397 -> `docs/changelog/2026-07-23.mdx`: Records progress coverage hardening. - #7391 -> `docs/changelog/2026-07-23.mdx`: Records centralized larger-runner routing. - #7423 -> `docs/changelog/2026-07-23.mdx`: Records one retry for confirmed hosted-runner loss. - #7399 -> `docs/changelog/2026-07-23.mdx`: Records runner-comparison telemetry. - #7270 -> `docs/changelog/2026-07-23.mdx`: Records staging Brev Launchable validation. - #7426 -> `docs/changelog/2026-07-23.mdx`: Records filtering of irrelevant base-image run history. - #7333 -> `docs/changelog/2026-07-23.mdx`: Records aligned Quickstart platform guidance. - #7343 -> `docs/changelog/2026-07-23.mdx`: Records documentation-writer receipt collection. - #7400 -> `docs/changelog/2026-07-23.mdx`: Records the documentation-writer receipt requirement for docs-only PRs. - #7413 -> `docs/changelog/2026-07-23.mdx`: Records removal of redundant receipt PR metadata. - #7405 -> `docs/changelog/2026-07-23.mdx`: Records corrected inference CLI references. - #7389 -> `docs/changelog/2026-07-23.mdx`: Records completion of the v0.0.91 documentation audit. `#7384` is an internal refactor with no intended runtime behavior change. `#7401` updates internal CodeQL Actions dependencies. `#7376` is already contained in `v0.0.92`, so it is outside the release-entry scan range despite its retained planning label. ## 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 dated changelog structure, SPDX syntax, and version headings. - [ ] 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: Reviewed `docs/changelog/2026-07-23.mdx` against `WRITING.md`, `docs/CONTRIBUTING.md`, `docs/.docs-skip`, `docs/index.yml`, the six user-visible source PRs, and the remaining grouped release commits. The review corrected an ambiguous qualification claim, confirmed all published routes, preserved the DGX OS `7.6.x` caveat, and found no remaining action. - Agent: Codex Desktop <!-- docs-review-head-sha: ec0a866 --> <!-- docs-review-agents-blob-sha: 9c9b36d --> ## DGX Station Hardware Evidence - [ ] Tested on DGX Station - Tested commit: Not applicable. This PR does not change `scripts/prepare-dgx-station-host.sh`. - 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 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 — `npx vitest run test/changelog-docs.test.ts`: 1 file and 6 tests passed. - [ ] Applicable broad gate passed — Not applicable to one native changelog file. - [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) — completed with 0 errors and 2 existing 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) — not applicable because native changelog entries use a parser-safe MDX SPDX comment without frontmatter. --- Signed-off-by: Carlos Villela <cvillela@nvidia.com> <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Added the v0.0.93 changelog covering onboarding and validation improvements. * Documented support for additional DGX Station Express workstation releases and clearer handling of existing vLLM workloads. * Added guidance for optional Hugging Face authentication, resumable rate-limit recovery, and DGX Spark provider selection. * Clarified installer behavior on Intel macOS, release validation requirements, hosted-runner retries, documentation checks, and supported CLI quickstart paths. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
Summary
This draft completes the two unowned follow-ups from the v0.0.91 post-tag documentation audit.
It documents the remaining rebuild data-loss and base-image override constraints, and preserves flat Markdown legacy routes for the Additional Setup migration.
Changes
docs/manage-sandboxes/recover-rebuild-sandboxes.mdxanddocs/changelog/2026-07-22.mdx: Document whenrebuild --forcecan continue after a manifest-declared state-file backup failure, what state it restores, and which base-image overrides remain trusted.fern/docs.yml,scripts/check-docs-published-routes.mts, andtest/station-doc-ownership.test.ts: Add direct.mdand.mdxredirects for the pre-variant DGX Station and Windows Prerequisites routes, reject duplicate mappings, and validate each destination against the published route index.Type of Change
Quality Gates
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/station-doc-ownership.test.tspassed 3 tests;npx vitest run test/check-docs-published-routes.test.tspassed 25 tests;npx vitest run test/changelog-docs.test.tspassed 6 tests.npm testfor broad runtime/test-harness changes;npm run checkfor repo-wide validation/coverage changes, command/result: Not run. The focused docs tests and build cover this change.npm run docsbuilds without warnings (doc changes only). The build completed with 0 errors and the existing light-mode accent contrast warning.Signed-off-by: Miyoung Choi miyoungc@nvidia.com
Summary by CodeRabbit
Documentation
--force, and how partial/restored state works.base-imageoverrides to immutable digests and clarified when local bases are accepted..mdand.mdxroutes (versioned and unversioned).Tests
fern/docs.ymland asserting exact{ source, destination }matches for.md/.mdx.Chores