Skip to content

docs: add host-side NemoClaw state reference - #6158

Closed
WilliamK112 wants to merge 1 commit into
NVIDIA:mainfrom
WilliamK112:codex/nemoclaw-host-files-state-6088
Closed

docs: add host-side NemoClaw state reference#6158
WilliamK112 wants to merge 1 commit into
NVIDIA:mainfrom
WilliamK112:codex/nemoclaw-host-files-state-6088

Conversation

@WilliamK112

@WilliamK112 WilliamK112 commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

Summary

Closes #6088.

Local validation

  • npx vitest run --project integration test/host-files-state-doc.test.ts
  • npx biome check test/host-files-state-doc.test.ts
  • npm run docs:check-agent-variants
  • fern check via the repo-pinned Fern version from fern/fern.config.json
  • bash test/e2e/e2e-cloud-experimental/check-docs.sh --only-links --local-only docs/reference/host-files-and-state.mdx docs/manage-sandboxes/lifecycle.mdx
  • git diff --check

Summary by CodeRabbit

  • New Features

    • Added a new reference page covering host-side files and state, including what is kept after uninstall and how host vs. sandbox storage differs.
    • Added the new page to the docs navigation for both product variants.
    • Expanded command and setup docs with clearer variant-specific guidance and links to the new reference page.
  • Tests

    • Added coverage to verify the new documentation page, its navigation entries, and key host-state clarifications.

@copy-pr-bot

copy-pr-bot Bot commented Jul 2, 2026

Copy link
Copy Markdown

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

@github-actions

github-actions Bot commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

This repository limits contributors to 10 open pull requests. Please close or merge existing PRs before opening new ones.

@github-actions github-actions Bot closed this Jul 2, 2026
@coderabbitai

coderabbitai Bot commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 8385db66-3403-4a10-a83a-ec01a8350f02

📥 Commits

Reviewing files that changed from the base of the PR and between ba687cf and fb1388f.

📒 Files selected for processing (5)
  • docs/index.yml
  • docs/manage-sandboxes/lifecycle.mdx
  • docs/reference/commands-nemohermes.mdx
  • docs/reference/host-files-and-state.mdx
  • test/host-files-state-doc.test.ts

📝 Walkthrough

Walkthrough

Adds a new "Host Files and State" documentation page describing ~/.nemoclaw/ host-side state, links it into navigation for both agent variants and from lifecycle uninstall docs, adds a validation test, and extensively rewrites commands-nemohermes.mdx to scope sections by OpenClaw vs Hermes using AgentOnly blocks.

Changes

Host Files and State reference page

Layer / File(s) Summary
New Host Files and State MDX page
docs/reference/host-files-and-state.mdx
New page with frontmatter, host-vs-sandbox explanation, preserved/removed host path tables, sandbox-side state section, and related references.
Navigation entries and lifecycle link
docs/index.yml, docs/manage-sandboxes/lifecycle.mdx
Adds the new page to navigation for OpenClaw and Hermes variants; adds a reference link to it from the lifecycle uninstall note.
Validation tests
test/host-files-state-doc.test.ts
New Vitest suite asserting navigation wiring and page content match expected host-file references.

AgentOnly variant scoping in commands-nemohermes.mdx

Layer / File(s) Summary
Intro, in-sandbox commands, onboarding flags
docs/reference/commands-nemohermes.mdx
Wraps intro content, in-sandbox command tables, Brave Search/tool policy guidance, and onboarding flag/backup-path docs in AgentOnly blocks.
exec/agent/recover/gateway restart docs
docs/reference/commands-nemohermes.mdx
Scopes exec, agent, recover, and gateway restart command behavior descriptions by variant.
Status, doctor, maintenance exec docs
docs/reference/commands-nemohermes.mdx
Scopes status/version, doctor config-permission checks, and maintenance exec cleanup docs by variant.
dashboard-url and gateway-token docs
docs/reference/commands-nemohermes.mdx
Splits token/URL retrieval documentation into OpenClaw and Hermes variants.
skill install/remove and agents apply docs
docs/reference/commands-nemohermes.mdx
Scopes skill install/remove differences and documents the new OpenClaw-only agents apply subcommand.
sessions export, rebuild, tunnel, inference docs
docs/reference/commands-nemohermes.mdx
Scopes sessions export, rebuild, tunnel stop, and inference set documentation by variant.
Environment variable docs
docs/reference/commands-nemohermes.mdx
Scopes dashboard bind/port env vars, adds OpenClaw build-time agent config vars, extra agents JSON schema, and remote deployment defaults.

Estimated code review effort: 3 (Moderate) | ~25 minutes

Possibly related PRs

  • NVIDIA/NemoClaw#4811: Updates the same commands-nemohermes.mdx file around Hermes dashboard/API/port semantics, directly overlapping with this PR's dashboard-url/gateway-token variant scoping.

Suggested labels: area: docs

Suggested reviewers: miyoungc, ericksoa

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[All Platforms][Docs] no unified reference page for ~/.nemoclaw/ host-side config and state files — information scattered across 4+ pages

2 participants