Skip to content

docs: resolve maintainer docs gaps - #6213

Merged
miyoungc merged 3 commits into
mainfrom
docs/maintainer-docs-cleanup
Jul 2, 2026
Merged

docs: resolve maintainer docs gaps#6213
miyoungc merged 3 commits into
mainfrom
docs/maintainer-docs-cleanup

Conversation

@miyoungc

@miyoungc miyoungc commented Jul 2, 2026

Copy link
Copy Markdown
Collaborator

Summary

This PR resolves the maintainer-owned docs gaps behind the noisy contributor PR set without reusing that branch history. It adds missing recovery guidance and a host-side state reference while keeping OpenClaw-only gateway guidance out of the Hermes variant.

Related Issue

Closes #5326docs/get-started/windows-preparation.mdx: adds Cursor Run Mode / Legacy Terminal Tool troubleshooting for Windows starter-prompt installs, including fallback-file and Docker Desktop readiness guidance.
Closes #6027docs/reference/troubleshooting.mdx: adds Kubernetes namespace not ready recovery steps that clean failed setup state before retrying install, with preserved-user-data notes.
Closes #6028docs/get-started/prerequisites.mdx, docs/reference/troubleshooting.mdx, ci/platform-matrix.json, docs/reference/platform-support.mdx: documents that Homebrew Colima users must install both Colima and the Docker CLI and verify docker info.
Closes #6030AGENTS.md: clarifies that nemoclaw/ registers /nemoclaw OpenClaw TUI slash commands and that the openclaw nemoclaw <cmd> shell subcommand path is descoped.
Closes #6031docs/reference/troubleshooting.mdx: adds OpenShell/OpenClaw gateway startup-order guidance for the OpenClaw variant and replaces stopped-sandbox guidance with a lighter recovery ladder before rebuild.
Closes #6088docs/reference/host-files-and-state.mdx, docs/manage-sandboxes/lifecycle.mdx, docs/index.yml: adds a unified ~/.nemoclaw/ host files and state reference, including current sandboxes.json registry wording and uninstall preservation behavior.

Changes

  • Add Windows Cursor recovery guidance to the Windows preparation page instead of expanding the starter prompt.
  • Document Homebrew Colima needing the Docker CLI, Kubernetes namespace cleanup, OpenShell/OpenClaw gateway order, and sandbox_container_stopped recovery.
  • Add a Host Files and State reference page, wire it into both OpenClaw and Hermes navigation, and link related docs.
  • Clarify the descoped openclaw nemoclaw <cmd> path in the agent architecture table.

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-only change; validated with docs generators, link checks, and Fern docs build.
  • 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:

Verification

  • PR description includes the DCO sign-off declaration and every commit appears as Verified in GitHub
  • Git hooks passed during commit and push, or npx prek run --from-ref main --to-ref HEAD passes
  • Targeted tests pass for changed behavior
  • Full npm test passes (broad runtime changes only)
  • 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)
  • Doc pages follow the style guide (doc changes only)
  • New doc pages include SPDX header and frontmatter (new pages only)

Commands run:

  • python3 scripts/generate-platform-docs.py --check
  • npm run docs:check-agent-variants
  • bash test/e2e/e2e-cloud-experimental/check-docs.sh --only-links --local-only docs/get-started/windows-preparation.mdx docs/resources/agent-skills.mdx docs/reference/troubleshooting.mdx docs/reference/host-files-and-state.mdx
  • git diff --check
  • npm run docs — passed with 0 errors; Fern reported 1 warning.
  • npm run build:cli — run so the pre-push TypeScript hook could resolve dist/ imports.

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

Summary by CodeRabbit

  • New Features

    • Added a new reference page explaining NemoClaw host-side storage, safe-to-delete items, and how uninstall preserves or destroys data.
    • Added the new “Host Files and State” page to the user-guide navigation for both agent variants.
  • Documentation

    • Improved macOS Apple Silicon + Homebrew Colima setup by explicitly requiring the Docker CLI and verifying with docker info.
    • Expanded Windows troubleshooting guidance and added clearer recovery steps for onboarding and stopped sandboxes, including the correct startup order for gateways.

Document missing recovery and reference paths for Windows starter-prompt installs,
macOS Colima setup, Kubernetes namespace cleanup, stopped sandbox recovery,
host-side state files, and agent install readiness.

Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
@miyoungc miyoungc added area: docs Documentation, examples, guides, or docs build chore Build, CI, dependency, or tooling maintenance labels Jul 2, 2026
@miyoungc miyoungc self-assigned this Jul 2, 2026
@coderabbitai

coderabbitai Bot commented Jul 2, 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: d36b3784-17ef-4ed4-aac2-a1697220eb00

📥 Commits

Reviewing files that changed from the base of the PR and between 8e9477c and b7af08f.

📒 Files selected for processing (2)
  • docs/get-started/windows-preparation.mdx
  • docs/reference/troubleshooting.mdx
✅ Files skipped from review due to trivial changes (1)
  • docs/get-started/windows-preparation.mdx
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/reference/troubleshooting.mdx

📝 Walkthrough

Walkthrough

Documentation-only updates covering macOS Colima/Docker CLI prerequisites, a Windows Cursor install-blocking troubleshooting entry, Kubernetes namespace recovery and gateway startup order guidance, a stepwise sandbox recovery procedure, a new host files reference page with navigation entries, and an AGENTS.md plugin description clarification.

Changes

Documentation and troubleshooting updates

Layer / File(s) Summary
AGENTS.md plugin description update
AGENTS.md
Rewrites the nemoclaw/ architecture row to describe /nemoclaw TUI slash-command registration and mark the shell subcommand path as descoped.
macOS Colima and Docker CLI prerequisites
ci/platform-matrix.json, docs/get-started/prerequisites.mdx, docs/reference/platform-support.mdx, docs/reference/troubleshooting.mdx
Adds guidance requiring brew install colima docker so the Docker CLI is available alongside Colima on macOS Apple Silicon, updated across prerequisites, platform notes, and troubleshooting.
Windows Cursor install blocking troubleshooting
docs/get-started/windows-preparation.mdx
Adds a troubleshooting entry describing Cursor blocking the starter prompt install command due to terminal or Run Mode restrictions, with recovery steps and a secrets-handling note.
Kubernetes namespace, gateway order, and sandbox recovery guidance
docs/reference/troubleshooting.mdx
Adds subsections for recovering from Kubernetes namespace not ready via uninstall/reinstall, documents OpenShell/OpenClaw gateway startup order, and replaces the generic stopped-sandbox note with a staged recovery ladder.
Host files and state reference page
docs/reference/host-files-and-state.mdx, docs/manage-sandboxes/lifecycle.mdx, docs/index.yml
Adds a new reference page cataloging ~/.nemoclaw/ files and directories with safe-to-delete guidance and uninstall behavior, linked from lifecycle uninstall guidance and added to OpenClaw and Hermes navigation.

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

Possibly related PRs

  • NVIDIA/NemoClaw#4552: Both PRs edit docs/get-started/prerequisites.mdx and its macOS platform-matrix row.
  • NVIDIA/NemoClaw#4632: This PR's docs/index.yml navigation addition builds on the variant-based docs structure changed there.
  • NVIDIA/NemoClaw#4078: Both PRs update troubleshooting guidance around Docker/OpenShell gateway health and recovery behavior.

Suggested reviewers: cv, ericksoa, jyaunches

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Title check ❓ Inconclusive The title is relevant but generic, and it doesn't indicate the main documentation updates or affected areas. Rename it to mention the key docs fixes, such as Windows/Cursor recovery, Colima Docker CLI, and host-state/troubleshooting updates.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Linked Issues check ✅ Passed The PR covers each linked docs gap: Windows Cursor recovery, namespace cleanup, Colima Docker CLI, AGENTS clarification, gateway/sandbox recovery, and host-state reference.
Out of Scope Changes check ✅ Passed The added nav, lifecycle note, and platform docs all support the documented objectives; no unrelated changes stand out.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/maintainer-docs-cleanup

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

@github-code-quality

github-code-quality Bot commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

Code Coverage Overview

Languages: TypeScript

TypeScript / code-coverage/plugin

The overall coverage in the docs/maintainer-docs... branch is 96%. Coverage data for the main branch is not yet available.

Show a code coverage summary of the most covered files.
File main docs/maintainer-docs... b7af08f +/-
nemoclaw/src/se...cret-scanner.ts 100%
nemoclaw/src/commands/slash.ts 100%
nemoclaw/src/bl...eprint/state.ts 98%
nemoclaw/src/onboard/config.ts 98%
nemoclaw/src/bl...int/snapshot.ts 97%
nemoclaw/src/blueprint/ssrf.ts 97%
nemoclaw/src/bl...print/runner.ts 95%
nemoclaw/src/co...ration-state.ts 94%
nemoclaw/src/bl...ate-networks.ts 94%
nemoclaw/src/index.ts 94%

TypeScript / code-coverage/cli

The overall coverage in the docs/maintainer-docs... branch is 69%. Coverage data for the main branch is not yet available.

Show a code coverage summary of the most covered files.
File main docs/maintainer-docs... b7af08f +/-
src/lib/actions...dbox/rebuild.ts 82%
src/lib/actions...all/run-plan.ts 80%
src/lib/state/o...oard-session.ts 79%
src/lib/shields/index.ts 75%
src/lib/state/sandbox.ts 73%
src/lib/onboard...er-gpu-patch.ts 69%
src/lib/onboard/preflight.ts 69%
src/lib/actions...licy-channel.ts 59%
src/lib/policy/index.ts 56%
src/lib/onboard.ts 20%

Updated July 02, 2026 23:08 UTC
Code Coverage is in Public Preview. Learn more and provide us with your feedback.

@github-actions

github-actions Bot commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

@github-actions

github-actions Bot commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

E2E Advisor Recommendation

Required E2E: None
Optional E2E: None

Workflow run

Full advisor summary

E2E Recommendation Advisor

Base: origin/main
Head: HEAD
Confidence: high

Required E2E

  • None. No E2E is recommended because this is a documentation/platform-claim update only. The PR adds and edits guidance about prerequisites, Windows/Colima troubleshooting, host state files, sandbox recovery, and docs navigation, but does not touch runtime code or assets that can affect installer/onboarding execution, resume state handling, sandbox lifecycle implementation, credential handling, security boundaries, network policy enforcement, inference routing, deployment logic, or real assistant user flows.

Optional E2E

  • None.

New E2E recommendations

  • None.

@github-actions

github-actions Bot commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

E2E Target Recommendation

Required E2E targets: None
Optional E2E targets: None

Workflow run

Full E2E target advisor summary

E2E Target Advisor

Base: origin/main
Head: HEAD
Confidence: high

Required E2E targets

  • None. Changes are documentation, agent guidance, and platform support/launch-claim metadata only. They do not touch .github/workflows/e2e.yaml, test/e2e target registry/runtime support, shared E2E fixtures/support, live E2E tests, manifests, or source paths that affect E2E target behavior.

Optional E2E targets

  • None.

Relevant changed files

  • None.

@github-actions

github-actions Bot commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

PR Review Advisor (Nemotron Ultra) — No blocking findings

Merge posture: No blocking advisor findings
Primary next action: Add or justify PRA-T1 and any related test follow-ups.
Open items: 0 required · 0 warnings · 0 suggestions · 3 test follow-ups
Since last review: 0 prior items resolved · 0 still apply · 0 new items found

Action checklist

  • PRA-T1 Add or justify test follow-up: Runtime validation
  • PRA-T2 Add or justify test follow-up: Runtime validation
  • PRA-T3 Add or justify test follow-up: Runtime validation
Test follow-ups to resolve or justify

If these cover changed behavior, prefer adding them in this PR; otherwise state why existing coverage is enough or link the follow-up.

  • PRA-T1 Runtime validation — Run python3 scripts/generate-platform-docs.py --check to verify platform matrix renders correctly. Docs-only PR; runtime validation needed for docs generation: generate-platform-docs.py --check, npm run docs:check-agent-variants, npm run docs. Author reports all pass.
  • PRA-T2 Runtime validation — Run npm run docs:check-agent-variants to verify both OpenClaw and Hermes navigation includes new Host Files and State page. Docs-only PR; runtime validation needed for docs generation: generate-platform-docs.py --check, npm run docs:check-agent-variants, npm run docs. Author reports all pass.
  • PRA-T3 Runtime validation — Run npm run docs to verify Fern build passes with new pages. Docs-only PR; runtime validation needed for docs generation: generate-platform-docs.py --check, npm run docs:check-agent-variants, npm run docs. Author reports all pass.

Workflow run details

This is an automated, non-binding review; it still expects maintainers and agents to respond to each required or warning item. Treat suggestions as current-PR improvements when they touch changed code; defer only with maintainer rationale or a linked follow-up. A human maintainer must make the final merge decision.

@miyoungc

miyoungc commented Jul 2, 2026

Copy link
Copy Markdown
Collaborator Author

Addressing PR Review Advisor test follow-ups:

@github-actions

github-actions Bot commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

PR Review Advisor — No blocking findings

Merge posture: No blocking advisor findings
Primary next action: Add or justify PRA-T1 and any related test follow-ups.
Open items: 0 required · 0 warnings · 0 suggestions · 5 test follow-ups
Since last review: 4 prior items resolved · 0 still apply · 0 new items found

Action checklist

  • PRA-T1 Add or justify test follow-up: Runtime validation
  • PRA-T2 Add or justify test follow-up: Runtime validation
  • PRA-T3 Add or justify test follow-up: Runtime validation
  • PRA-T4 Add or justify test follow-up: Runtime validation
  • PRA-T5 Add or justify test follow-up: Runtime validation
Test follow-ups to resolve or justify

If these cover changed behavior, prefer adding them in this PR; otherwise state why existing coverage is enough or link the follow-up.

  • PRA-T1 Runtime validation — Docs agent-variant generation: verify `Host Files and State` renders for both OpenClaw and Hermes navigation and that Hermes output rewrites `$$nemoclaw` to `nemohermes`.. The PR is docs-only and current acceptance/security concerns are addressed, but several documented behaviors describe runtime recovery paths and generated-doc synchronization that are best protected by targeted validation rather than broad test runs.
  • PRA-T2 Runtime validation — Platform matrix synchronization: verify the Homebrew Colima Docker CLI note in `ci/platform-matrix.json` is rendered into both prerequisites and platform support docs without drift.. The PR is docs-only and current acceptance/security concerns are addressed, but several documented behaviors describe runtime recovery paths and generated-doc synchronization that are best protected by targeted validation rather than broad test runs.
  • PRA-T3 Runtime validation — Docs trust-boundary safety: reject versioned uninstall fallback examples that contain `curl ... | bash`, and require download, local inspection, and local `bash uninstall.sh` execution.. The PR is docs-only and current acceptance/security concerns are addressed, but several documented behaviors describe runtime recovery paths and generated-doc synchronization that are best protected by targeted validation rather than broad test runs.
  • PRA-T4 Runtime validation — Windows Cursor fallback transcript: verify the assistant offers a local `.bat`/`.ps1` fallback only when manual local scripts are organization-permitted, shows exact file contents before execution, checks Docker Desktop and WSL integration first, and keeps secrets out of chat and generated scripts.. The PR is docs-only and current acceptance/security concerns are addressed, but several documented behaviors describe runtime recovery paths and generated-doc synchronization that are best protected by targeted validation rather than broad test runs.
  • PRA-T5 Runtime validation — Docker-driver stopped container recovery: stop a labeled sandbox container and verify `$$nemoclaw <name> status` attempts non-destructive recovery and reports refreshed OpenShell state before rebuild guidance.. The PR is docs-only and current acceptance/security concerns are addressed, but several documented behaviors describe runtime recovery paths and generated-doc synchronization that are best protected by targeted validation rather than broad test runs.

Workflow run details

This is an automated, non-binding review; it still expects maintainers and agents to respond to each required or warning item. Treat suggestions as current-PR improvements when they touch changed code; defer only with maintainer rationale or a linked follow-up. A human maintainer must make the final merge decision.

@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

🧹 Nitpick comments (1)
docs/reference/troubleshooting.mdx (1)

620-637: 📐 Maintainability & Code Quality | 🔵 Trivial | 💤 Low value

Consider cross-linking ~/.nemoclaw/ reference.

Line 630 describes what uninstall preserves under ~/.nemoclaw/; this PR also adds a dedicated Host Files and State reference page elsewhere in the stack that documents this directory in detail. Linking here would help readers find the fuller picture without duplicating the file-by-file breakdown.

🤖 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/reference/troubleshooting.mdx` around lines 620 - 637, The
troubleshooting section for Kubernetes namespace recovery should cross-link the
`~/.nemoclaw/` mention to the dedicated Host Files and State reference page
instead of leaving it as plain text. Update the prose around the uninstall
guidance so readers can jump from the `~/.nemoclaw/` reference to the fuller
documentation, using the existing troubleshooting heading and nearby uninstall
instructions as the anchor.
🤖 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/reference/host-files-and-state.mdx`:
- Line 50: The backlink in the host-files-and-state reference points to the
wrong section slug, so update the link target to match the actual uninstall
section in Manage Sandbox Lifecycle. Locate the markdown reference in the
host-files-and-state doc and the `Uninstall` section in
`docs/manage-sandboxes/lifecycle.mdx`, then either change the link to the real
generated slug or add a stable explicit anchor and keep both references aligned.

---

Nitpick comments:
In `@docs/reference/troubleshooting.mdx`:
- Around line 620-637: The troubleshooting section for Kubernetes namespace
recovery should cross-link the `~/.nemoclaw/` mention to the dedicated Host
Files and State reference page instead of leaving it as plain text. Update the
prose around the uninstall guidance so readers can jump from the `~/.nemoclaw/`
reference to the fuller documentation, using the existing troubleshooting
heading and nearby uninstall instructions as the anchor.
🪄 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: 5bcd3868-8787-4f68-8b51-d7be8f37967d

📥 Commits

Reviewing files that changed from the base of the PR and between 55f8fb9 and a87efdd.

📒 Files selected for processing (11)
  • AGENTS.md
  • ci/platform-matrix.json
  • docs/get-started/prerequisites.mdx
  • docs/get-started/windows-preparation.mdx
  • docs/index.yml
  • docs/manage-sandboxes/lifecycle.mdx
  • docs/reference/host-files-and-state.mdx
  • docs/reference/platform-support.mdx
  • docs/reference/troubleshooting.mdx
  • docs/resources/agent-install-readiness.mdx
  • docs/resources/agent-skills.mdx

Comment thread docs/reference/host-files-and-state.mdx Outdated
miyoungc added 2 commits July 2, 2026 15:44
Remove the agent install readiness checklist from this docs cleanup.
Keep the PR focused on resolved documentation gaps with concrete page updates.

Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
Align uninstall fallback docs with the CLI download-review-run boundary and
make Windows local-script fallback conditional on policy and user inspection.

Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
@miyoungc
miyoungc merged commit 8dcc563 into main Jul 2, 2026
45 checks passed
@miyoungc
miyoungc deleted the docs/maintainer-docs-cleanup branch July 2, 2026 23:24
@cv cv mentioned this pull request Jul 2, 2026
21 tasks
cv added a commit that referenced this pull request Jul 2, 2026
<!-- markdownlint-disable MD041 -->
## Summary
This PR prepares the user-facing documentation for v0.0.73 before the
release plan is frozen.
It adds release notes for the merged runtime changes and closes
documentation gaps around DNS-backed HTTPS endpoint validation and
LangChain Deep Agents Code proxy recovery.

## Changes
- Add the `v0.0.73` release-note section with links to the detailed
command, inference, recovery, lifecycle, platform, and setup
documentation.
- Correct the custom endpoint guidance so DNS-backed HTTPS rejection and
the supported alternatives match the fail-closed runtime behavior.
- Document the managed `inference.local` proxy boundary and rebuild
requirement for existing LangChain Deep Agents Code sandboxes.
- Add troubleshooting guidance for the DNS-backed HTTPS validation
error.
- Validate with `npm run docs:sync-agent-variants` and `npm run docs`;
Fern completed with 0 errors and 2 existing warnings.
- Source summary:
- [#6139](#6139) ->
`docs/about/release-notes.mdx`, `docs/inference/inference-options.mdx`,
`docs/reference/commands.mdx`, `docs/reference/commands-nemohermes.mdx`,
and `docs/reference/troubleshooting.mdx`: Document fail-closed
DNS-backed HTTPS endpoint handling and recovery options.
- [#6142](#6142) ->
`docs/about/release-notes.mdx`: Summarize native OpenShell GPU injection
and compatibility-path diagnostics.
- [#6197](#6197) ->
`docs/about/release-notes.mdx`: Summarize agent-aware messaging preset
rejection.
- [#6199](#6199) ->
`docs/about/release-notes.mdx`: Summarize the unreachable-sandbox backup
opt-in, restore behavior, and data-loss boundary.
- [#6204](#6204) and
[#6206](#6206) ->
`docs/about/release-notes.mdx` and
`docs/get-started/quickstart-langchain-deepagents-code.mdx`: Document
the corrected managed proxy contract and required sandbox rebuild.
- [#6213](#6213) ->
`docs/about/release-notes.mdx`: Summarize the merged setup, recovery,
and host-state documentation.

## 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
<!-- Check all that apply. For any "covered by existing tests", "not
applicable", or waiver entry, add a brief justification on the same line
or in the Changes section. -->
- [ ] Tests added or updated for changed behavior
- [ ] Existing tests cover changed behavior — justification:
- [x] Tests not applicable — justification: documentation-only release
preparation; the Fern docs build validates the changed pages and routes.
- [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:

## Verification
<!-- Check each item you ran and confirmed. Leave unchecked items you
skipped. Doc-only changes do not require npm test unless you ran it. -->
- [x] PR description includes the DCO sign-off declaration and every
commit appears as `Verified` in GitHub
- [x] Git hooks passed during commit and push, or `npx prek run
--from-ref main --to-ref HEAD` passes
- [ ] Targeted tests pass for changed behavior
- [ ] Full `npm test` passes (broad runtime changes only)
- [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)
- [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)

---
<!-- DCO sign-off is required in this PR description, and every commit
must appear as Verified in GitHub. Run: git config user.name && git
config user.email -->
Signed-off-by: Carlos Villela <cvillela@nvidia.com>


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

* **Documentation**
* Added a new **v0.0.73** release notes section with six highlights at
the top of the changelog.
* Expanded **Custom Endpoint URL Validation** guidance in inference
option docs, including explicit acceptance/rejection rules for HTTP vs
DNS-backed HTTPS and how validated IPs are stored.
* Updated command references (`nemohermes inference set`, `$$nemoclaw
inference set`) to match the new validation behavior.
* Added troubleshooting documentation for unsupported **DNS-backed HTTPS
endpoints**, plus clarified Deep Agents Code routing and post-upgrade
sandbox rebuild guidance.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Signed-off-by: Carlos Villela <cvillela@nvidia.com>
Hadar301 pushed a commit to Hadar301/NemoClaw-OpenShift that referenced this pull request Jul 12, 2026
## Summary
This PR resolves the maintainer-owned docs gaps behind the noisy
contributor PR set without reusing that branch history. It adds missing
recovery guidance and a host-side state reference while keeping
OpenClaw-only gateway guidance out of the Hermes variant.

## Related Issue
Closes NVIDIA#5326 — `docs/get-started/windows-preparation.mdx`: adds Cursor
Run Mode / Legacy Terminal Tool troubleshooting for Windows
starter-prompt installs, including fallback-file and Docker Desktop
readiness guidance.
Closes NVIDIA#6027 — `docs/reference/troubleshooting.mdx`: adds `Kubernetes
namespace not ready` recovery steps that clean failed setup state before
retrying install, with preserved-user-data notes.
Closes NVIDIA#6028 — `docs/get-started/prerequisites.mdx`,
`docs/reference/troubleshooting.mdx`, `ci/platform-matrix.json`,
`docs/reference/platform-support.mdx`: documents that Homebrew Colima
users must install both Colima and the Docker CLI and verify `docker
info`.
Closes NVIDIA#6030 — `AGENTS.md`: clarifies that `nemoclaw/` registers
`/nemoclaw` OpenClaw TUI slash commands and that the `openclaw nemoclaw
<cmd>` shell subcommand path is descoped.
Closes NVIDIA#6031 — `docs/reference/troubleshooting.mdx`: adds
OpenShell/OpenClaw gateway startup-order guidance for the OpenClaw
variant and replaces stopped-sandbox guidance with a lighter recovery
ladder before rebuild.
Closes NVIDIA#6088 — `docs/reference/host-files-and-state.mdx`,
`docs/manage-sandboxes/lifecycle.mdx`, `docs/index.yml`: adds a unified
`~/.nemoclaw/` host files and state reference, including current
`sandboxes.json` registry wording and uninstall preservation behavior.

## Changes
- Add Windows Cursor recovery guidance to the Windows preparation page
instead of expanding the starter prompt.
- Document Homebrew Colima needing the Docker CLI, Kubernetes namespace
cleanup, OpenShell/OpenClaw gateway order, and
`sandbox_container_stopped` recovery.
- Add a `Host Files and State` reference page, wire it into both
OpenClaw and Hermes navigation, and link related docs.
- Clarify the descoped `openclaw nemoclaw <cmd>` path in the agent
architecture table.

## Type of Change

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

## Quality Gates
- [ ] Tests added or updated for changed behavior
- [ ] Existing tests cover changed behavior — justification:
- [x] Tests not applicable — justification: docs-only change; validated
with docs generators, link checks, and Fern docs build.
- [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:

## Verification
- [x] PR description includes the DCO sign-off declaration and every
commit appears as `Verified` in GitHub
- [x] Git hooks passed during commit and push, or `npx prek run
--from-ref main --to-ref HEAD` passes
- [ ] Targeted tests pass for changed behavior
- [ ] Full `npm test` passes (broad runtime changes only)
- [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)
- [x] Doc pages follow the [style
guide](https://github.com/NVIDIA/NemoClaw/blob/main/docs/CONTRIBUTING.md)
(doc changes only)
- [x] New doc pages include SPDX header and frontmatter (new pages only)

Commands run:
- `python3 scripts/generate-platform-docs.py --check`
- `npm run docs:check-agent-variants`
- `bash test/e2e/e2e-cloud-experimental/check-docs.sh --only-links
--local-only docs/get-started/windows-preparation.mdx
docs/resources/agent-skills.mdx docs/reference/troubleshooting.mdx
docs/reference/host-files-and-state.mdx`
- `git diff --check`
- `npm run docs` — passed with 0 errors; Fern reported 1 warning.
- `npm run build:cli` — run so the pre-push TypeScript hook could
resolve `dist/` imports.

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


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

* **New Features**
* Added a new reference page explaining NemoClaw host-side storage,
safe-to-delete items, and how uninstall preserves or destroys data.
* Added the new “Host Files and State” page to the user-guide navigation
for both agent variants.

* **Documentation**
* Improved macOS Apple Silicon + Homebrew Colima setup by explicitly
requiring the Docker CLI and verifying with `docker info`.
* Expanded Windows troubleshooting guidance and added clearer recovery
steps for onboarding and stopped sandboxes, including the correct
startup order for gateways.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
Hadar301 pushed a commit to Hadar301/NemoClaw-OpenShift that referenced this pull request Jul 12, 2026
<!-- markdownlint-disable MD041 -->
## Summary
This PR prepares the user-facing documentation for v0.0.73 before the
release plan is frozen.
It adds release notes for the merged runtime changes and closes
documentation gaps around DNS-backed HTTPS endpoint validation and
LangChain Deep Agents Code proxy recovery.

## Changes
- Add the `v0.0.73` release-note section with links to the detailed
command, inference, recovery, lifecycle, platform, and setup
documentation.
- Correct the custom endpoint guidance so DNS-backed HTTPS rejection and
the supported alternatives match the fail-closed runtime behavior.
- Document the managed `inference.local` proxy boundary and rebuild
requirement for existing LangChain Deep Agents Code sandboxes.
- Add troubleshooting guidance for the DNS-backed HTTPS validation
error.
- Validate with `npm run docs:sync-agent-variants` and `npm run docs`;
Fern completed with 0 errors and 2 existing warnings.
- Source summary:
- [NVIDIA#6139](NVIDIA#6139) ->
`docs/about/release-notes.mdx`, `docs/inference/inference-options.mdx`,
`docs/reference/commands.mdx`, `docs/reference/commands-nemohermes.mdx`,
and `docs/reference/troubleshooting.mdx`: Document fail-closed
DNS-backed HTTPS endpoint handling and recovery options.
- [NVIDIA#6142](NVIDIA#6142) ->
`docs/about/release-notes.mdx`: Summarize native OpenShell GPU injection
and compatibility-path diagnostics.
- [NVIDIA#6197](NVIDIA#6197) ->
`docs/about/release-notes.mdx`: Summarize agent-aware messaging preset
rejection.
- [NVIDIA#6199](NVIDIA#6199) ->
`docs/about/release-notes.mdx`: Summarize the unreachable-sandbox backup
opt-in, restore behavior, and data-loss boundary.
- [NVIDIA#6204](NVIDIA#6204) and
[NVIDIA#6206](NVIDIA#6206) ->
`docs/about/release-notes.mdx` and
`docs/get-started/quickstart-langchain-deepagents-code.mdx`: Document
the corrected managed proxy contract and required sandbox rebuild.
- [NVIDIA#6213](NVIDIA#6213) ->
`docs/about/release-notes.mdx`: Summarize the merged setup, recovery,
and host-state documentation.

## 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
<!-- Check all that apply. For any "covered by existing tests", "not
applicable", or waiver entry, add a brief justification on the same line
or in the Changes section. -->
- [ ] Tests added or updated for changed behavior
- [ ] Existing tests cover changed behavior — justification:
- [x] Tests not applicable — justification: documentation-only release
preparation; the Fern docs build validates the changed pages and routes.
- [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:

## Verification
<!-- Check each item you ran and confirmed. Leave unchecked items you
skipped. Doc-only changes do not require npm test unless you ran it. -->
- [x] PR description includes the DCO sign-off declaration and every
commit appears as `Verified` in GitHub
- [x] Git hooks passed during commit and push, or `npx prek run
--from-ref main --to-ref HEAD` passes
- [ ] Targeted tests pass for changed behavior
- [ ] Full `npm test` passes (broad runtime changes only)
- [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)
- [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)

---
<!-- DCO sign-off is required in this PR description, and every commit
must appear as Verified in GitHub. Run: git config user.name && git
config user.email -->
Signed-off-by: Carlos Villela <cvillela@nvidia.com>


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

* **Documentation**
* Added a new **v0.0.73** release notes section with six highlights at
the top of the changelog.
* Expanded **Custom Endpoint URL Validation** guidance in inference
option docs, including explicit acceptance/rejection rules for HTTP vs
DNS-backed HTTPS and how validated IPs are stored.
* Updated command references (`nemohermes inference set`, `$$nemoclaw
inference set`) to match the new validation behavior.
* Added troubleshooting documentation for unsupported **DNS-backed HTTPS
endpoints**, plus clarified Deep Agents Code routing and post-upgrade
sandbox rebuild guidance.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Signed-off-by: Carlos Villela <cvillela@nvidia.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment