Skip to content

docs: complete v0.0.91 audit follow-ups - #7389

Merged
miyoungc merged 4 commits into
mainfrom
codex/post-tag-docs-followups
Jul 22, 2026
Merged

docs: complete v0.0.91 audit follow-ups#7389
miyoungc merged 4 commits into
mainfrom
codex/post-tag-docs-followups

Conversation

@miyoungc

@miyoungc miyoungc commented Jul 22, 2026

Copy link
Copy Markdown
Collaborator

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

  • perf(e2e): accelerate Hermes rebuild validation #7213 -> docs/manage-sandboxes/recover-rebuild-sandboxes.mdx and docs/changelog/2026-07-22.mdx: Document when rebuild --force can continue after a manifest-declared state-file backup failure, what state it restores, and which base-image overrides remain trusted.
  • docs: complete post-tag audit follow-ups #7261 -> fern/docs.yml, scripts/check-docs-published-routes.mts, and test/station-doc-ownership.test.ts: Add direct .md and .mdx redirects for the pre-variant DGX Station and Windows Prerequisites routes, reject duplicate mappings, and validate each destination against the published route index.
  • Existing Markdown clients require the redirect compatibility paths because Fern's generic redirects do not preserve these retired flat routes.

Type of Change

  • Code change (feature, bug fix, or refactor)
  • Code change with doc updates
  • Doc only (prose changes, no code sample modifications)
  • Doc only (includes code sample changes)

Quality Gates

  • Tests added or updated for changed behavior
  • Existing tests cover changed behavior, justification:
  • Tests not applicable, justification:
  • 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:

DGX Station Hardware Evidence

  • Tested on DGX Station
  • Tested commit: Not applicable. This PR changes documentation routes only.
  • Station profile/scenario: Not applicable.
  • Result: Not applicable.
  • Supporting evidence: Not applicable.

Verification

  • PR description includes a Signed-off-by: line and every commit appears as Verified in GitHub
  • Normal pre-commit, commit-msg, and pre-push hooks passed, or npm run check:diff passed when hooks were skipped or unavailable
  • Targeted behavior tests pass for the current change set, or tests are marked not applicable above, command/result: npx vitest run test/station-doc-ownership.test.ts passed 3 tests; npx vitest run test/check-docs-published-routes.test.ts passed 25 tests; 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: Not run. The focused docs tests and build cover this change.
  • Quality Gates section completed with required justifications or waivers
  • No secrets, API keys, or credentials committed
  • npm run docs builds without warnings (doc changes only). The build completed with 0 errors and the existing light-mode accent contrast warning.
  • Doc pages follow the style guide (doc changes only)
  • New doc pages include SPDX header and frontmatter (new pages only)

Signed-off-by: Miyoung Choi miyoungc@nvidia.com

Summary by CodeRabbit

  • Documentation

    • Clarified “Rebuilds” behavior when manifest-declared state can’t be archived, including --force, and how partial/restored state works.
    • Tightened guidance for remote base-image overrides to immutable digests and clarified when local bases are accepted.
    • Updated prerequisite documentation redirects to include legacy .md and .mdx routes (versioned and unversioned).
  • Tests

    • Strengthened redirect validation by parsing fern/docs.yml and asserting exact { source, destination } matches for .md/.mdx.
    • Added a test to reject an “Additional Setup” redirect to an unpublished destination.
  • Chores

    • Expanded published-route redirect checking to include “Additional Setup” paths.

@miyoungc miyoungc added area: docs Documentation, examples, guides, or docs build v0.0.92 labels Jul 22, 2026
@miyoungc miyoungc self-assigned this Jul 22, 2026
@copy-pr-bot

copy-pr-bot Bot commented Jul 22, 2026

Copy link
Copy Markdown

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.

@coderabbitai

coderabbitai Bot commented Jul 22, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 70f47c22-cc49-4ef3-9497-d7d341d0545c

📥 Commits

Reviewing files that changed from the base of the PR and between 000311d and 169b914.

📒 Files selected for processing (1)
  • scripts/check-docs-published-routes.mts
🚧 Files skipped from review as they are similar to previous changes (1)
  • scripts/check-docs-published-routes.mts

📝 Walkthrough

Walkthrough

The 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.

Changes

Rebuild guidance

Layer / File(s) Summary
Rebuild safety and recovery guidance
docs/changelog/2026-07-22.mdx, docs/manage-sandboxes/recover-rebuild-sandboxes.mdx
Documentation clarifies rebuild stopping conditions, --force recovery behavior, partial state restoration, and base-image requirements.

Prerequisite redirects

Layer / File(s) Summary
Prerequisite redirect mappings and validation
fern/docs.yml, scripts/check-docs-published-routes.mts, test/station-doc-ownership.test.ts, test/check-docs-published-routes.test.ts
Redirects cover versioned and unversioned Markdown, MDX, and HTML-style routes for station and Windows preparation pages; route checks and tests validate exact suffix-aware mappings and unpublished Additional Setup destinations.

Estimated code review effort: 2 (Simple) | ~10 minutes

Possibly related PRs

  • NVIDIA/NemoClaw#7346: Extends the same published-route validation logic for deployment redirects.
  • NVIDIA/NemoClaw#7376: Modifies the same v0.0.91 changelog with overlapping rebuild safety clarifications.

Suggested labels: bug-fix, v0.0.91

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title is concise and accurately describes this PR as completing v0.0.91 documentation audit follow-ups.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch codex/post-tag-docs-followups

Comment @coderabbitai help to get the list of available commands.

@github-code-quality

github-code-quality Bot commented Jul 22, 2026

Copy link
Copy Markdown
Contributor

Code Coverage Overview

Languages: TypeScript

TypeScript / code-coverage/plugin

The overall coverage in commit 169b914 in the codex/post-tag-docs-... branch remains at 96%, unchanged from commit 1d418f5 in the main branch.

TypeScript / code-coverage/cli

The overall coverage in commit 169b914 in the codex/post-tag-docs-... branch remains at 80%, unchanged from commit 1d418f5 in the main branch.

Show a code coverage summary of the most impacted files.
File main 1d418f5 codex/post-tag-docs-... 169b914 +/-
src/lib/inferen...lama/process.ts 100% 50% -50%
src/lib/inferen...er-lifecycle.ts 71% 65% -6%
src/lib/adapter...shell/client.ts 90% 88% -2%
src/lib/shields/index.ts 72% 71% -1%
src/lib/sandbox...rce-identity.ts 87% 87% 0%
src/lib/state/m...-acquisition.ts 84% 89% +5%
src/lib/onboard...ndbox-create.ts 83% 91% +8%
src/lib/onboard...-desktop-gpu.ts 77% 89% +12%
src/lib/onboard...-create-plan.ts 75% 88% +13%
src/lib/onboard...ndbox-create.ts 33% 83% +50%

Updated July 22, 2026 18:55 UTC

@github-actions

Copy link
Copy Markdown
Contributor

@miyoungc
miyoungc marked this pull request as ready for review July 22, 2026 17:51

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick comments (1)
test/station-doc-ownership.test.ts (1)

138-141: 🎯 Functional Correctness | 🔵 Trivial | 🏗️ Heavy lift

Assert 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

📥 Commits

Reviewing files that changed from the base of the PR and between 1d418f5 and 1bce0e7.

📒 Files selected for processing (4)
  • docs/changelog/2026-07-22.mdx
  • docs/manage-sandboxes/recover-rebuild-sandboxes.mdx
  • fern/docs.yml
  • test/station-doc-ownership.test.ts

@github-actions

github-actions Bot commented Jul 22, 2026

Copy link
Copy Markdown
Contributor

PR Review Advisor — Informational

Advisor assessment: Informational / low confidence
Next action: No advisor follow-up needed.
Findings: 0 blockers · 0 warnings · 0 suggestions
Status: PR review advisor failed: PR review advisor SDK execution failed: session: ci-operations-analysis omitted required analysis; turn: ci-operations-analysis: ci-operations-analysis omitted required analysis

Model lanes

  • GPT-5.6 Terra (primary): Failed
  • Nemotron 3 Ultra (second opinion): Completed · high confidence · 0 blockers · 0 warnings · 0 suggestions

Nemotron output stays in workflow artifacts and does not change the assessment above.

E2E guidance

Advisory only. E2E / PR Gate selects and runs jobs independently.

Recommended E2E: None

Workflow run details

This automated review informs maintainers. Warnings and suggestions do not require a response. A maintainer decides whether to merge.

@miyoungc

Copy link
Copy Markdown
Collaborator Author

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 npm run docs pass.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

📥 Commits

Reviewing files that changed from the base of the PR and between 1bce0e7 and 3e548e0.

📒 Files selected for processing (2)
  • scripts/check-docs-published-routes.mts
  • test/station-doc-ownership.test.ts

Comment thread scripts/check-docs-published-routes.mts Outdated
@miyoungc

Copy link
Copy Markdown
Collaborator Author

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. npx vitest run test/check-docs-published-routes.test.ts passes all 25 tests.

@miyoungc miyoungc added v0.0.93 and removed v0.0.92 labels Jul 22, 2026
@miyoungc

Copy link
Copy Markdown
Collaborator Author

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 senthilr-nv left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@miyoungc
miyoungc merged commit c136c37 into main Jul 22, 2026
73 of 77 checks passed
@miyoungc
miyoungc deleted the codex/post-tag-docs-followups branch July 22, 2026 19:47
@cv cv mentioned this pull request Jul 23, 2026
23 tasks
cv added a commit that referenced this pull request Jul 23, 2026
<!-- 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 -->
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area: docs Documentation, examples, guides, or docs build

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants