mirror of
https://github.com/NVIDIA/NemoClaw.git
synced 2026-07-03 03:37:16 +00:00
8dcc563716
## 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 #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 #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 #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 #6030 — `AGENTS.md`: clarifies that `nemoclaw/` registers `/nemoclaw` OpenClaw TUI slash commands and that the `openclaw nemoclaw <cmd>` shell subcommand path is descoped. Closes #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 #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> |
||
|---|---|---|
| .. | ||
| coverage-threshold-cli.json | ||
| coverage-threshold-plugin.json | ||
| env-var-doc-allowlist.json | ||
| platform-matrix.json | ||
| source-shape-test-budget.json | ||
| test-file-size-budget.json | ||