docs: add host-side NemoClaw state reference - #6160
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Enterprise Run ID: 📒 Files selected for processing (4)
✅ Files skipped from review due to trivial changes (1)
🚧 Files skipped from review as they are similar to previous changes (2)
📝 WalkthroughWalkthroughAdds a new reference page for ChangesDocumentation updates
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 unit tests (beta)
Comment |
fb1388f to
714a90e
Compare
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (3)
docs/reference/host-files-and-state.mdx (1)
24-28: 📐 Maintainability & Code Quality | 🔵 Trivial | 💤 Low valueConsider a
<Note>callout for the destructive-action caveat.This section explains how to trigger data loss (
--destroy-user-data, env var, interactive prompt), similar in nature to the<Note>already used for this exact topic inlifecycle.mdx. Wrapping it in a Fern<Note>/<Warning>would be more consistent with the doc guideline and make the caveat harder to miss when skimming the table.As per coding guidelines, "Use Fern callout components such as
<Note>,<Tip>, and<Warning>for callouts in MDX pages."🤖 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/host-files-and-state.mdx` around lines 24 - 28, The uninstall data-loss caveat in the “User Data Preserved By Uninstall” section should be presented as a Fern callout for consistency and visibility. Update the MDX content around the uninstall behavior text to wrap the destructive-action warning in a `<Note>` or `<Warning>` component, matching the style used in `lifecycle.mdx`, while keeping the same `$$nemoclaw uninstall` and `nemohermes uninstall` guidance and the `--destroy-user-data` / `NEMOCLAW_UNINSTALL_DESTROY_USER_DATA` references.Source: Coding guidelines
test/host-files-state-doc.test.ts (1)
43-48: 📐 Maintainability & Code Quality | 🔵 Trivial | 💤 Low valueFull-sentence literal assertions are brittle to doc rewording.
These
toContainchecks lock in exact doc phrasing (e.g."because \HOME=/sandbox` there", full sentence in line 47). A copyedit that preserves the same meaning will break this test even though the documented claim still holds. Consider asserting on shorter, meaning-carrying key phrases (e.g. ``HOME=/sandbox`` and ``/sandbox/.nemoclaw/config.json` ``) rather than entire sentences.As per path instructions, "Prefer observable outcomes through the public boundary over source-text, private-shape, or mock-call assertions."
🤖 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/host-files-state-doc.test.ts` around lines 43 - 48, The test in host-files-state-doc is too brittle because it asserts full doc sentences instead of the observable claim. Update the assertions in the doc check to use shorter, meaning-carrying phrases tied to the public content, such as the `HOME=/sandbox` mention and `/sandbox/.nemoclaw/config.json`, rather than exact wording. Keep the `doc`-based `toContain` checks in this test but make them resilient to copyedits by targeting the key identifiers from the documented behavior.Source: Path instructions
docs/reference/commands-nemohermes.mdx (1)
552-556: 🎯 Functional Correctness | 🔵 Trivial | 💤 Low valueDuplicate the
nemohermes <name> execheading.
Two sections use the same heading text at lines 552 and 955. Merge theexeccontent into one section or rename one heading so the generated anchors stay unique and the two command descriptions do not diverge.🤖 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/commands-nemohermes.mdx` around lines 552 - 556, The `nemohermes <name> exec` heading is duplicated, which creates conflicting anchors and splits one command’s documentation across two sections. In the `commands-nemohermes.mdx` content, either merge the duplicate `exec` section into the existing `nemohermes <name> exec` entry or rename one of the headings so each command has a unique title; keep the descriptions aligned under a single canonical section.
🤖 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/commands-nemohermes.mdx`:
- Around line 2616-2619: The MDX block under AgentOnly variant="openclaw" is
missing a paragraph break before the “### Remote Deployment” heading, so it may
not render correctly as an h3. Update the content in the AgentOnly section to
insert a blank line immediately after the opening AgentOnly tag, keeping the
heading in its own paragraph so the MDX parser recognizes it properly.
---
Nitpick comments:
In `@docs/reference/commands-nemohermes.mdx`:
- Around line 552-556: The `nemohermes <name> exec` heading is duplicated, which
creates conflicting anchors and splits one command’s documentation across two
sections. In the `commands-nemohermes.mdx` content, either merge the duplicate
`exec` section into the existing `nemohermes <name> exec` entry or rename one of
the headings so each command has a unique title; keep the descriptions aligned
under a single canonical section.
In `@docs/reference/host-files-and-state.mdx`:
- Around line 24-28: The uninstall data-loss caveat in the “User Data Preserved
By Uninstall” section should be presented as a Fern callout for consistency and
visibility. Update the MDX content around the uninstall behavior text to wrap
the destructive-action warning in a `<Note>` or `<Warning>` component, matching
the style used in `lifecycle.mdx`, while keeping the same `$$nemoclaw uninstall`
and `nemohermes uninstall` guidance and the `--destroy-user-data` /
`NEMOCLAW_UNINSTALL_DESTROY_USER_DATA` references.
In `@test/host-files-state-doc.test.ts`:
- Around line 43-48: The test in host-files-state-doc is too brittle because it
asserts full doc sentences instead of the observable claim. Update the
assertions in the doc check to use shorter, meaning-carrying phrases tied to the
public content, such as the `HOME=/sandbox` mention and
`/sandbox/.nemoclaw/config.json`, rather than exact wording. Keep the
`doc`-based `toContain` checks in this test but make them resilient to copyedits
by targeting the key identifiers from the documented behavior.
🪄 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: 62295e32-8c82-44ce-ab55-f872d7b09b45
📒 Files selected for processing (5)
docs/index.ymldocs/manage-sandboxes/lifecycle.mdxdocs/reference/commands-nemohermes.mdxdocs/reference/host-files-and-state.mdxtest/host-files-state-doc.test.ts
| <AgentOnly variant="openclaw"> | ||
| ### Remote Deployment | ||
|
|
||
| The following variables seed defaults for `nemohermes deploy` and `nemohermes onboard --remote`, which provision a sandbox on a Brev instance. |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
set -euo pipefail
# Show the relevant region with line numbers.
sed -n '2608,2624p' docs/reference/commands-nemohermes.mdx | cat -n
printf '\n--- nearby AgentOnly examples ---\n'
rg -n -C 1 '^<AgentOnly' docs/reference/commands-nemohermes.mdx | sed -n '1,40p'Repository: NVIDIA/NemoClaw
Length of output: 3305
Add a blank line after <AgentOnly variant="openclaw">
### Remote Deployment needs its own paragraph break so MDX renders it as an h3.
🤖 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/commands-nemohermes.mdx` around lines 2616 - 2619, The MDX
block under AgentOnly variant="openclaw" is missing a paragraph break before the
“### Remote Deployment” heading, so it may not render correctly as an h3. Update
the content in the AgentOnly section to insert a blank line immediately after
the opening AgentOnly tag, keeping the heading in its own paragraph so the MDX
parser recognizes it properly.
wscurran
added
area: docs
|
✨ Thanks for the docs update. This adds a unified host-side state reference and links it from both OpenClaw and Hermes navigation. Related open PRs:
Related open issues: |
|
Thanks for the contribution. Please pause and re-check the repository requirements before requesting further review. NemoClaw has several layers of contributor guidance that must be followed for every PR: If you are using an AI coding agent, please make sure it is actually reading and following those repo instructions. The repeated misses here should be fixed in your agent workflow before opening or updating more PRs. Closing for now. Please reopen after the DCO declaration and commit verification requirements are resolved. |
3 participants
Summary
Host Files and Statereference for host-side~/.nemoclaw/files, including preserved uninstall data, runtime state, local inference adapter files, and legacy credential statedocs:check-agent-variantsCloses #6088.
Supersedes #6158, which was automatically closed by the contributor PR-limit workflow before stale no-diff PR #5402 was cleaned up.
Local validation
npx vitest run --project integration test/host-files-state-doc.test.tsnpx biome check test/host-files-state-doc.test.tsnpm run docs:check-agent-variantsfern checkvia the repo-pinned Fern version fromfern/fern.config.jsonbash test/e2e/e2e-cloud-experimental/check-docs.sh --only-links --local-only docs/reference/host-files-and-state.mdx docs/manage-sandboxes/lifecycle.mdxgit diff --checkSummary by CodeRabbit
~/.nemoclaw/paths, what’s preserved on uninstall, and related sandbox-side notes.