docs: complete post-tag audit follow-ups - #7261
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. |
📝 WalkthroughWalkthroughThe PR migrates setup links to Additional Setup routes, adds legacy redirects and ownership tests, expands DGX Station preparation guidance, refreshes platform/provider documentation, and documents sandbox recovery and gateway-selection behavior. ChangesDocumentation and operational guidance
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 docstrings
🧪 Generate unit tests (beta)
Comment |
|
🌿 Preview your docs: https://nvidia-preview-pr-7261.docs.buildwithfern.com/nemoclaw |
Code Coverage OverviewLanguages: TypeScript TypeScript / code-coverage/pluginThe overall coverage in commit ae86955 in the TypeScript / code-coverage/cliThe overall coverage in commit ae86955 in the Show a code coverage summary of the most impacted files.
Updated |
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: 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
🤖 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 `@fern/docs.yml`:
- Around line 396-419: The flat legacy routes for both DGX Station and Windows
preparation need Markdown-extension redirects and test coverage. In
fern/docs.yml lines 396-419, add .md and .mdx source redirects for both latest
and unversioned prerequisite routes, preserving each extension while targeting
the existing destinations; in test/station-doc-ownership.test.ts lines 125-129,
include .md and .mdx in the flat-route suffix matrix and preserve the suffix in
expected destinations.
🪄 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: d5c39ebf-9a59-4f11-82d7-ca6f2c927f21
📒 Files selected for processing (21)
ci/platform-matrix.jsondocs/changelog/2026-05-28.mdxdocs/changelog/2026-06-29.mdxdocs/changelog/2026-06-30.mdxdocs/changelog/2026-07-02.mdxdocs/changelog/2026-07-04.mdxdocs/changelog/2026-07-17.mdxdocs/changelog/2026-07-18.mdxdocs/changelog/2026-07-20.mdxdocs/get-started/dgx-station-preparation.mdxdocs/get-started/prerequisites.mdxdocs/get-started/quickstart.mdxdocs/index.ymldocs/inference/choose-inference-provider.mdxdocs/inference/set-up-vllm.mdxdocs/manage-sandboxes/recover-rebuild-sandboxes.mdxdocs/reference/commands.mdxdocs/reference/platform-support.mdxdocs/reference/troubleshooting.mdxfern/docs.ymltest/station-doc-ownership.test.ts
| - source: "/nemoclaw/latest/get-started/prerequisites/dgx-station-preparation" | ||
| destination: "/nemoclaw/latest/user-guide/openclaw/get-started/additional-setup/dgx-station-preparation" | ||
| - source: "/nemoclaw/latest/get-started/prerequisites/dgx-station-preparation.html" | ||
| destination: "/nemoclaw/latest/user-guide/openclaw/get-started/additional-setup/dgx-station-preparation" | ||
| - source: "/nemoclaw/latest/get-started/prerequisites/dgx-station-preparation/index.html" | ||
| destination: "/nemoclaw/latest/user-guide/openclaw/get-started/additional-setup/dgx-station-preparation" | ||
| - source: "/nemoclaw/get-started/prerequisites/dgx-station-preparation" | ||
| destination: "/nemoclaw/user-guide/openclaw/get-started/additional-setup/dgx-station-preparation" | ||
| - source: "/nemoclaw/get-started/prerequisites/dgx-station-preparation.html" | ||
| destination: "/nemoclaw/user-guide/openclaw/get-started/additional-setup/dgx-station-preparation" | ||
| - source: "/nemoclaw/get-started/prerequisites/dgx-station-preparation/index.html" | ||
| destination: "/nemoclaw/user-guide/openclaw/get-started/additional-setup/dgx-station-preparation" | ||
| - source: "/nemoclaw/latest/get-started/prerequisites/windows-preparation" | ||
| destination: "/nemoclaw/latest/user-guide/openclaw/get-started/additional-setup/windows-preparation" | ||
| - source: "/nemoclaw/latest/get-started/prerequisites/windows-preparation.html" | ||
| destination: "/nemoclaw/latest/user-guide/openclaw/get-started/additional-setup/windows-preparation" | ||
| - source: "/nemoclaw/latest/get-started/prerequisites/windows-preparation/index.html" | ||
| destination: "/nemoclaw/latest/user-guide/openclaw/get-started/additional-setup/windows-preparation" | ||
| - source: "/nemoclaw/get-started/prerequisites/windows-preparation" | ||
| destination: "/nemoclaw/user-guide/openclaw/get-started/additional-setup/windows-preparation" | ||
| - source: "/nemoclaw/get-started/prerequisites/windows-preparation.html" | ||
| destination: "/nemoclaw/user-guide/openclaw/get-started/additional-setup/windows-preparation" | ||
| - source: "/nemoclaw/get-started/prerequisites/windows-preparation/index.html" | ||
| destination: "/nemoclaw/user-guide/openclaw/get-started/additional-setup/windows-preparation" |
There was a problem hiding this comment.
🗄️ Data Integrity & Integration | 🟠 Major | ⚡ Quick win
Preserve flat legacy Markdown route forms too.
The variant redirects include .md and .mdx, but flat legacy routes do not. Those URLs bypass these explicit rules, and the test currently cannot catch the gap.
fern/docs.yml#L396-L419: add.mdand.mdxredirects for both retired pages under/nemoclaw/latest/get-started/prerequisites/and/nemoclaw/get-started/prerequisites/.test/station-doc-ownership.test.ts#L125-L129: include.mdand.mdxin the flat-route suffix matrix and preserve the extension in expected destinations.
📍 Affects 2 files
fern/docs.yml#L396-L419(this comment)test/station-doc-ownership.test.ts#L125-L129
🤖 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 `@fern/docs.yml` around lines 396 - 419, The flat legacy routes for both DGX
Station and Windows preparation need Markdown-extension redirects and test
coverage. In fern/docs.yml lines 396-419, add .md and .mdx source redirects for
both latest and unversioned prerequisite routes, preserving each extension while
targeting the existing destinations; in test/station-doc-ownership.test.ts lines
125-129, include .md and .mdx in the flat-route suffix matrix and preserve the
suffix in expected destinations.
Sources: Coding guidelines, Path instructions
<!-- markdownlint-disable MD041 --> ## Summary Add the canonical `## v0.0.90` entry to `docs/changelog/2026-07-20.mdx` before the release tag is planned. The update also corrects the documented custom-image migration window so the compatibility fallback that first ships in v0.0.90 remains available until v0.0.91. ## Changes - Add the v0.0.90 summary and detailed release bullets for managed-image routing, provider-reset recovery, WhatsApp health reporting, and DGX Station guidance. - Keep the newest release first in the shared dated changelog and use root-absolute links to the canonical OpenClaw routes. - Correct `docs/reference/commands.mdx` to state that the legacy image route selector remains supported through v0.0.90 and is removed in v0.0.91. - Release source summary: - [#7264](#7264) -> `docs/resources/prompt-assets/dgx-station.md`, `docs/changelog/2026-07-20.mdx`: Record the versioned Station installer path, Nemotron 3 Ultra 550B default, and explicit DeepSeek override. - [#7261](#7261) -> `docs/get-started/dgx-station-preparation.mdx`, `docs/manage-sandboxes/recover-rebuild-sandboxes.mdx`, `docs/changelog/2026-07-20.mdx`: Include the OpenIB, legacy recovery, and Additional Setup documentation follow-ups. - [#7232](#7232) -> `docs/changelog/2026-07-20.mdx`: Document provider-reset recovery for wrapped OpenShell attachment diagnostics. - [#7189](#7189) -> `docs/reference/commands.mdx`, `docs/changelog/2026-07-20.mdx`: Document the managed-image route-selector rename and correct its one-release migration window. - [#7015](#7015) -> `docs/changelog/2026-07-20.mdx`: Document corrected OpenClaw WhatsApp health reporting. - No additional user-facing page update is needed for [#7193](#7193), [#7110](#7110), [#6783](#6783), or [#7263](#7263) because they change contributor governance, internal CI or release automation, or editorial style without changing supported user behavior. - [#7242](#7242) and [#7225](#7225) are already ancestors of and documented in v0.0.89, so this entry does not duplicate them despite their stale v0.0.90 labels. ## 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 heading, SPDX form, version order, 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: ## DGX Station Hardware Evidence - [ ] Tested on DGX Station - Tested commit: Not applicable; this PR does not change `scripts/prepare-dgx-station-host.sh` or runtime behavior. - 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` (6 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 run; this is a focused documentation-only change. - [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) — passed with 0 errors and two unrelated baseline warnings for unauthenticated redirect checks and the existing light-mode contrast ratio. - [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: Julie Yaunches <jyaunches@nvidia.com> <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **Documentation** - Added release notes for v0.0.90 covering inference routing, credential reset behavior, WhatsApp status detection, and DGX Station coding-agent guidance. - Updated custom Dockerfile guidance to document continued support for the legacy provider argument through v0.0.90. - Clarified that legacy declarations must be renamed to `NEMOCLAW_INFERENCE_PROVIDER_ID` before v0.0.91. - Added and refreshed related documentation links. <!-- end of auto-generated comment: release notes by coderabbit.ai --> Signed-off-by: Julie Yaunches <jyaunches@nvidia.com>
<!-- markdownlint-disable MD041 --> ## 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 - #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. - #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 - [x] Doc only (prose changes, no code sample modifications) - [ ] Doc only (includes code sample changes) ## Quality Gates - [x] Tests added or updated for changed behavior - [ ] Existing tests cover changed behavior, justification: - [ ] 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: ## 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 - [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: `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. - [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 completed with 0 errors and the 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) --- Signed-off-by: Miyoung Choi <miyoungc@nvidia.com> <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## 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. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
Summary
Complete the documentation fast-follow from the v0.0.86 through v0.0.88 post-tag audits. This adds durable recovery and OpenIB guidance, corrects the v0.0.87 force-install record, and gives platform-specific setup a focused navigation home without duplicating the full DGX Station procedure in generated reference tables.
Changes
/sandbox/user-data.--force-station-installescape hatch with its retained validation boundaries.Type of Change
Quality Gates
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/changelog-docs.test.ts test/station-doc-ownership.test.ts test/check-docs-published-routes.test.ts test/check-docs-links.test.ts(44 passed)npm testfor broad runtime/test-harness changes;npm run checkfor repo-wide validation/coverage changes — command/result: Not run; this is a documentation-only change with focused coverage.npm run docsbuilds without warnings (doc changes only) — passed with 0 errors and 1 Fern warningSigned-off-by: Miyoung Choi miyoungc@nvidia.com
Summary by CodeRabbit
Documentation
Bug Fixes