docs: recommend backup-all for host backups#4164
Merged
Merged
Conversation
Contributor
|
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 (1)
💤 Files with no reviewable changes (1)
📝 WalkthroughWalkthroughDocumentation updated to clarify sandbox destruction deletes workspace/state, add a "Back Up All Running Sandboxes" section documenting ChangesSandbox Backup Documentation
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Suggested labels
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
Contributor
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 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/manage-sandboxes/backup-restore.mdx`:
- Line 118: The docs currently show the wrong CLI syntax for snapshots; update
the example on that line to use the correct contract by replacing instances of
"nemoclaw <name> snapshot ..." with the proper form "nemoclaw sandbox snapshot
<list|restore|create> <name>" (e.g., use "nemoclaw sandbox snapshot list <name>"
and "nemoclaw sandbox snapshot restore <name>") so the documented commands match
the CLI.
- Around line 121-122: Update the paragraph in
docs/manage-sandboxes/backup-restore.mdx that mentions
scripts/backup-workspace.sh to include a direct link to the script in the
NemoClaw source tree; locate the text that reads "scripts/backup-workspace.sh"
and replace or augment it with a hyperlink pointing to the exact repository path
for that file (e.g., the GitHub/GitLab URL to scripts/backup-workspace.sh) while
keeping the surrounding note about the installer and the suggested host commands
(nemoclaw backup-all and snapshot commands) unchanged.
🪄 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: ed7ea862-9ef4-489d-8ce2-73199069da0e
📒 Files selected for processing (1)
docs/manage-sandboxes/backup-restore.mdx
Contributor
There was a problem hiding this comment.
🧹 Nitpick comments (2)
docs/manage-sandboxes/backup-restore.mdx (2)
145-148: ⚡ Quick winSplit sentences to one per line.
Lines 147 and 148 each contain multiple sentences. The style guide requires one sentence per line to make diffs readable.
Suggested formatting
`nemoclaw sandbox snapshot create <name>` automatically discovers every `workspace-*/` directory under the sandbox state tree and includes it in the snapshot bundle -alongside the default `workspace/`. `nemoclaw sandbox snapshot restore <name>` re-applies the full -per-agent set. No manual per-workspace backup pattern is needed. +alongside the default `workspace/`. +`nemoclaw sandbox snapshot restore <name>` re-applies the full per-agent set. +No manual per-workspace backup pattern is needed.As per coding guidelines: One sentence per line in source (makes diffs readable). Flag paragraphs where multiple sentences appear on the same line.
🤖 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/manage-sandboxes/backup-restore.mdx` around lines 145 - 148, Split the sentences on the lines that describe snapshot creation and restore so each sentence is on its own line; update the lines mentioning `nemoclaw sandbox snapshot create <name>`, the discovery of `workspace-*/` and inclusion of `workspace/`, and `nemoclaw sandbox snapshot restore <name>` so each sentence is separated onto its own line to comply with the one-sentence-per-line style rule.
15-15: ⚡ Quick winUse active voice.
The phrase "are permanently deleted" is passive. Per the style guide, active voice is required.
Suggested rewrite
-They persist across sandbox restarts but are **permanently deleted** when you run `nemoclaw <name> destroy`. +They persist across sandbox restarts, but `nemoclaw <name> destroy` **permanently deletes** them.As per coding guidelines: Active voice required. Flag passive constructions. Bad: "A gateway is created by the CLI." Good: "The CLI creates a gateway."
🤖 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/manage-sandboxes/backup-restore.mdx` at line 15, Rewrite the passive sentence "They persist across sandbox restarts but are permanently deleted when you run `nemoclaw <name> destroy`." to active voice: replace the passive clause with an active subject (the CLI/command) — e.g., "They persist across sandbox restarts, but the command `nemoclaw <name> destroy` permanently deletes them." Update the line in docs/manage-sandboxes/backup-restore.mdx where that exact phrase appears.
🤖 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.
Nitpick comments:
In `@docs/manage-sandboxes/backup-restore.mdx`:
- Around line 145-148: Split the sentences on the lines that describe snapshot
creation and restore so each sentence is on its own line; update the lines
mentioning `nemoclaw sandbox snapshot create <name>`, the discovery of
`workspace-*/` and inclusion of `workspace/`, and `nemoclaw sandbox snapshot
restore <name>` so each sentence is separated onto its own line to comply with
the one-sentence-per-line style rule.
- Line 15: Rewrite the passive sentence "They persist across sandbox restarts
but are permanently deleted when you run `nemoclaw <name> destroy`." to active
voice: replace the passive clause with an active subject (the CLI/command) —
e.g., "They persist across sandbox restarts, but the command `nemoclaw <name>
destroy` permanently deletes them." Update the line in
docs/manage-sandboxes/backup-restore.mdx where that exact phrase appears.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: 4976d9d5-1d27-4924-8ecc-d6462530f984
📒 Files selected for processing (1)
docs/manage-sandboxes/backup-restore.mdx
Contributor
|
✨ Thanks for submitting this detailed PR about updating the backup and restore documentation to include the snapshot workflow and 'nemoclaw backup-all' command. This proposes a fix for issue #3681 by replacing the source-tree 'scripts/backup-workspace.sh' section with the host-installed 'nemoclaw backup-all' workflow and explaining where 'backup-all' stores per-sandbox snapshot bundles. Related open issues: |
Signed-off-by: Glenn-Agent <glenn_agent@163.com>
013eb62 to
963cba9
Compare
cv
approved these changes
Jun 6, 2026
12 tasks
miyoungc
added a commit
that referenced
this pull request
Jun 8, 2026
## Summary - Add the v0.0.61 release notes from the GitHub dev announcement. - Document managed vLLM recovery after host reboot and Slack denied-mention feedback. - Refresh generated `nemoclaw-user-*` skills from the source docs. ## Source summary - #4983 -> `docs/about/release-notes.mdx`: Added the v0.0.61 release summary from the dev announcement and linked behavior groups to deeper docs. - #4904 -> `docs/inference/use-local-inference.mdx`: Documented that managed vLLM restarts the `nemoclaw-vllm` container after host reboot during recovery. - #4933 -> `docs/manage-sandboxes/messaging-channels.mdx`: Documented Slack sender feedback for denied channel `@mention` events. - #4879, #4915, #4935, #4759, #4164, #4888, #4897, #4944, #4959 -> `.agents/skills/`: Refreshed generated user skills from the current source docs for release prep. ## Verification - `python3 scripts/docs-to-skills.py docs/ .agents/skills/ --prefix nemoclaw-user --doc-platform fern-mdx` - `npm run docs` (passed outside the tool sandbox after `tsx` IPC pipe creation was blocked in the sandbox) - `npm run build:cli` (refreshed local `dist/` for the pre-push TypeScript hook) - Commit and pre-push hooks passed, including docs-to-skills verification, markdownlint, gitleaks, skills YAML tests, and CLI TypeScript. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Updated sandbox security documentation with file descriptor limits. * Changed default inference model for DGX Station profile. * Enhanced agent policy and backup/restore documentation. * Improved command reference examples with clearer formatting. * Clarified Slack messaging denial notice behavior. * Added automatic vLLM container recovery during host reboot. * Updated release notes for v0.0.61. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
12 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
scripts/backup-workspace.shsection with the host-installednemoclaw backup-allworkflowbackup-allstores per-sandbox snapshot bundles and how to inspect/restore themFixes #3681
Signed-off-by: Glenn-Agent glenn_agent@163.com
Verification
npm run docs:strict(passes; existing Fern upgrade warnings only)git diff --checkgit verify-commit HEADSummary by CodeRabbit