docs: catch up documentation for v0.0.16 changes - #1914
Merged
Conversation
Document snapshot create/list/restore commands, policy-remove command, rebuild command with version staleness detection, backup-all command, live enforced policy in status output, and bump doc versions through 0.0.16. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Contributor
📝 WalkthroughWalkthroughThis pull request adds documentation for newly introduced CLI commands and features in Nemoclaw, including policy removal, sandbox lifecycle management (rebuild, backup, snapshots), agent version awareness warnings, and updates the version catalog to include version 0.0.16. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
🧹 Nitpick comments (4)
docs/network-policy/customize-network-policy.md (1)
54-58: Use a period instead of a trailing colon in the new instruction sentence.Please end the sentence with a period and avoid a colon before the code block.
Suggested edit
-To remove a previously applied preset, use `nemoclaw <name> policy-remove`: +To remove a previously applied preset, use `nemoclaw <name> policy-remove`.As per coding guidelines, "Every sentence must end with a period." and "Colons should only introduce a list."
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/network-policy/customize-network-policy.md` around lines 54 - 58, Change the sentence that currently reads "To remove a previously applied preset, use `nemoclaw <name> policy-remove`:" to end with a period instead of a colon so it becomes "To remove a previously applied preset, use `nemoclaw <name> policy-remove`." and keep the following code block unchanged; update the sentence text near the code block shown in the diff accordingly.docs/workspace/backup-restore.md (1)
36-46: Tighten phrasing in the new snapshot section and remove trailing colon.
The fastest wayis superlative wording, and the restore instruction line should end with a period.
LLM pattern detected.Suggested edit
-The fastest way to back up and restore sandbox state is with the built-in snapshot commands. +Use the built-in snapshot commands to back up and restore sandbox state. @@ -To restore a specific snapshot instead of the latest, pass a timestamp or prefix: +To restore a specific snapshot instead of the latest, pass a timestamp or prefix.As per coding guidelines, "Superlatives and marketing language ... should be flagged" and "Every sentence must end with a period."
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/workspace/backup-restore.md` around lines 36 - 46, Replace the superlative opening "The fastest way to back up and restore sandbox state" with a neutral phrasing (e.g., "Use the built-in snapshot commands to back up and restore sandbox state.") and ensure all sentences end with a period; specifically change the restore instruction sentence that currently ends with a colon to end with a period. Keep the example CLI lines (`nemoclaw my-assistant snapshot create`, `nemoclaw my-assistant snapshot list`, `nemoclaw my-assistant snapshot restore`) and the note about snapshot storage path unchanged.docs/reference/troubleshooting.md (1)
293-305: Replace trailing colons with periods in the new troubleshooting steps.Use periods for the instruction lines before command blocks.
Suggested edit
-To upgrade the sandbox while preserving workspace state, run: +To upgrade the sandbox while preserving workspace state, run. @@ -Create a snapshot before rebuilding if you want an additional safety net: +Create a snapshot before rebuilding if you want an additional safety net.As per coding guidelines, "Every sentence must end with a period." and "Colons should only introduce a list."
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/reference/troubleshooting.md` around lines 293 - 305, Update the two instruction lines that currently end with colons to end with periods instead: change "To upgrade the sandbox while preserving workspace state, run:" and "Create a snapshot before rebuilding if you want an additional safety net:" to use periods. Ensure the surrounding explanatory sentences remain unchanged and that the code blocks that follow (the command examples for "nemoclaw <name> rebuild" and the snapshot+rebuild sequence) are still separated by a newline after the revised sentences..agents/skills/nemoclaw-user-reference/references/commands.md (1)
185-185: Consider removing implementation detail from user documentation.Mentioning the specific command
openshell policy get --fullexposes an internal implementation detail. User-facing documentation typically focuses on what the feature does rather than how it works internally.Consider simplifying to: "The Policy section displays the live enforced policy, which reflects presets added or removed after sandbox creation."
📝 Proposed simplification
-The Policy section displays the live enforced policy (fetched via `openshell policy get --full`), which reflects presets added or removed after sandbox creation. +The Policy section displays the live enforced policy, which reflects presets added or removed after sandbox creation.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In @.agents/skills/nemoclaw-user-reference/references/commands.md at line 185, Remove the internal command mention "openshell policy get --full" from the Policy section text and replace the sentence with a user-facing description such as: "The Policy section displays the live enforced policy, which reflects presets added or removed after sandbox creation." Locate the string "The Policy section displays the live enforced policy (fetched via `openshell policy get --full`)" in the commands.md content and update it to the simplified sentence to avoid exposing implementation details.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In @.agents/skills/nemoclaw-user-reference/references/commands.md:
- Line 185: Remove the internal command mention "openshell policy get --full"
from the Policy section text and replace the sentence with a user-facing
description such as: "The Policy section displays the live enforced policy,
which reflects presets added or removed after sandbox creation." Locate the
string "The Policy section displays the live enforced policy (fetched via
`openshell policy get --full`)" in the commands.md content and update it to the
simplified sentence to avoid exposing implementation details.
In `@docs/network-policy/customize-network-policy.md`:
- Around line 54-58: Change the sentence that currently reads "To remove a
previously applied preset, use `nemoclaw <name> policy-remove`:" to end with a
period instead of a colon so it becomes "To remove a previously applied preset,
use `nemoclaw <name> policy-remove`." and keep the following code block
unchanged; update the sentence text near the code block shown in the diff
accordingly.
In `@docs/reference/troubleshooting.md`:
- Around line 293-305: Update the two instruction lines that currently end with
colons to end with periods instead: change "To upgrade the sandbox while
preserving workspace state, run:" and "Create a snapshot before rebuilding if
you want an additional safety net:" to use periods. Ensure the surrounding
explanatory sentences remain unchanged and that the code blocks that follow (the
command examples for "nemoclaw <name> rebuild" and the snapshot+rebuild
sequence) are still separated by a newline after the revised sentences.
In `@docs/workspace/backup-restore.md`:
- Around line 36-46: Replace the superlative opening "The fastest way to back up
and restore sandbox state" with a neutral phrasing (e.g., "Use the built-in
snapshot commands to back up and restore sandbox state.") and ensure all
sentences end with a period; specifically change the restore instruction
sentence that currently ends with a colon to end with a period. Keep the example
CLI lines (`nemoclaw my-assistant snapshot create`, `nemoclaw my-assistant
snapshot list`, `nemoclaw my-assistant snapshot restore`) and the note about
snapshot storage path unchanged.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro Plus
Run ID: fda28e27-01bb-4ea7-97fb-598801299230
📒 Files selected for processing (9)
.agents/skills/nemoclaw-user-manage-policy/SKILL.md.agents/skills/nemoclaw-user-reference/references/commands.md.agents/skills/nemoclaw-user-reference/references/troubleshooting.md.agents/skills/nemoclaw-user-workspace/SKILL.mddocs/network-policy/customize-network-policy.mddocs/reference/commands.mddocs/reference/troubleshooting.mddocs/versions1.jsondocs/workspace/backup-restore.md
cv
approved these changes
Apr 15, 2026
wscurran
added
area: docs
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
3 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
nemoclaw <name> snapshot create/list/restorecommands (from feat(cli): add snapshot create/list/restore commands #1892)nemoclaw <name> policy-removecommand (from feat(policy): add policy-remove command to remove applied presets #1822)nemoclaw <name> rebuildcommand with version staleness detection (from feat(sandbox): version staleness detection and rebuild command #1870)nemoclaw backup-allcommand (from feat(sandbox): version staleness detection and rebuild command #1870)statusto mention live enforced policy display (from fix(status): show live enforced policy instead of stale baseline (#1132) #1896)connectandstatusto mention version staleness warnings (from feat(sandbox): version staleness detection and rebuild command #1870)destroyto reference snapshots and rebuild as alternativespolicy-removeto customize-network-policy pageTest plan
make docsbuilds without warnings🤖 Generated with Claude Code
Summary by CodeRabbit