Skip to content

docs: refresh documentation and user-skills for 0.0.34#3003

Merged
miyoungc merged 5 commits into
mainfrom
docs/catchup-weekend-updates
May 5, 2026
Merged

docs: refresh documentation and user-skills for 0.0.34#3003
miyoungc merged 5 commits into
mainfrom
docs/catchup-weekend-updates

Conversation

@miyoungc
Copy link
Copy Markdown
Contributor

@miyoungc miyoungc commented May 4, 2026

Summary

Catch up the docs for user-facing changes that landed over the weekend and today, so the published guidance matches current installer, onboarding, status, logs, local inference, rebuild backup behavior, the next docs version selector, and refreshed generated user skills.

Related Issue

None.

Changes

Type of Change

  • Code change (feature, bug fix, or refactor)
  • Code change with doc updates
  • Doc only (prose changes, no code sample modifications)
  • Doc only (includes code sample changes)

Verification

  • npx prek run --all-files passes
  • npm test passes
  • Tests added or updated for new or changed behavior
  • No secrets, API keys, or credentials committed
  • Docs updated for user-facing behavior changes
  • make docs builds without warnings (doc changes only)
  • Doc pages follow the style guide (doc changes only)
  • New doc pages include SPDX header and frontmatter (new pages only)

Signed-off-by: Miyoung Choi miyoungc@nvidia.com

Made with Cursor

Summary by CodeRabbit

  • Documentation
    • Expanded Ollama/local inference guidance with detailed WSL and Windows-host workflows, proxy/token behavior, and onboarding options
    • Standardized sandbox name validation and updated troubleshooting, CLI, and deploy docs to surface the rules and validation timing
    • Added/rewrote Manage Sandboxes, policy management, backup/restore, messaging channels, workspace persistence, and CLI selection guides
    • Refreshed quickstart/Hermes guidance, skill mappings, and bumped docs version to 0.0.34

Co-authored-by: Cursor <cursoragent@cursor.com>
@miyoungc miyoungc added the documentation Improvements or additions to documentation label May 4, 2026
@miyoungc miyoungc self-assigned this May 4, 2026
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 4, 2026

📝 Walkthrough

Walkthrough

Documentation-only changes: clarified Ollama/WSL/Windows local-inference behavior and proxy, standardized sandbox-name validation and default, documented scripted-installer env vars and CLI behavior (status/logs/rebuild), replaced workspace skill with a manage-sandboxes skill, added reference guides, and bumped docs version to 0.0.34.

Changes

Docs: Local Inference, Sandbox Naming, CLI References, and Day‑Two Skills

Layer / File(s) Summary
Docs manifest / Version
docs/project.json, docs/versions1.json
Bumped docs package version to 0.0.34 and added a new preferred docs entry for 0.0.34.
Onboarding & Local Inference (data/requirements)
docs/inference/use-local-inference.md, docs/get-started/quickstart.md, docs/get-started/windows-preparation.md, .agents/skills/nemoclaw-user-configure-inference/SKILL.md
Expanded and reorganized Ollama/local-inference guidance: detection/start/install options, WSL-specific host.docker.internal:11434 path, model pulls via Ollama HTTP API, non-WSL token-gated proxy (0.0.0.0:11435) vs WSL bypass, and wizard menu actions for Windows-host scenarios; added detailed local-inference provider notes.
Scripted installer & onboarding flags
docs/reference/commands.md, .agents/skills/nemoclaw-user-configure-inference/SKILL.md
Documented NEMOCLAW_NON_INTERACTIVE=1 and NEMOCLAW_ACCEPT_THIRD_PARTY_SOFTWARE=1 behavior and early-exit semantics when acceptance cannot be prompted.
Sandbox name validation & deploy timing
docs/deployment/deploy-to-remote-gpu.md, docs/reference/commands.md, docs/reference/troubleshooting.md, .agents/skills/nemoclaw-user-deploy-remote/SKILL.md
Standardized sandbox-name rules (lowercase; starts with letter; letters/numbers/internal hyphens only; ends with alphanumeric), documented NEMOCLAW_SANDBOX_NAME default my-assistant, and that legacy nemoclaw deploy validates names before provisioning.
CLI behavior & semantics
docs/reference/commands.md, .agents/skills/nemoclaw-user-reference/references/commands.md, docs/manage-sandboxes/lifecycle.md, docs/manage-sandboxes/workspace-files.md
Added not verified inference state and changed nemoclaw <name> status to exit non-zero on verification failure; nemoclaw <name> logs gains --tail/-n and --since; clarified rebuild behavior to abort before destroying original sandbox if manifest-defined state cannot be archived.
Day‑Two skills, references & routing
.agents/skills/*, .agents/skills/.../references/*, docs/resources/agent-skills.md
Replaced nemoclaw-user-workspace with nemoclaw-user-manage-sandboxes across skill lists; added manage-sandboxes skill and many reference docs (backup/restore, messaging channels, workspace-files, CLI selection guide, policy/change workflows); updated quickstart/hermes and other skill docs to point to manage-sandboxes.
Network policy & troubleshooting examples
.agents/skills/nemoclaw-user-reference/references/network-policies.md, .agents/skills/nemoclaw-user-reference/references/troubleshooting.md
Added openshell policy update example for live policy changes and a Telegram onboarding smoke-check troubleshooting note for OpenAI-compatible endpoints; updated cross-references.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Possibly related PRs

  • NVIDIA/NemoClaw#2793: Overlapping edits to skill documentation files (e.g., nemoclaw-user-configure-inference and related skill docs).

Suggested labels

enhancement: skill

Poem

🐰 I hopped through pages, soft and spry,
WSL, Windows, Ollama — now clarified.
Sandbox names dressed tidy and neat,
Installer flags make scripting sweet.
Docs updated, version bumped — a rabbit’s cheerful feat!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly summarizes the main change: refreshing documentation and user-skills for version 0.0.34, which aligns with the comprehensive documentation updates across multiple files in the changeset.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/catchup-weekend-updates

Tip

💬 Introducing Slack Agent: The best way for teams to turn conversations into code.

Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.

  • Generate code and open pull requests
  • Plan features and break down work
  • Investigate incidents and troubleshoot customer tickets together
  • Automate recurring tasks and respond to alerts with triggers
  • Summarize progress and report instantly

Built for teams:

  • Shared memory across your entire org—no repeating context
  • Per-thread sandboxes to safely plan and execute work
  • Governance built-in—scoped access, auditability, and budget controls

One agent for your entire SDLC. Right inside Slack.

👉 Get started


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

@miyoungc miyoungc added the v0.0.33 Release target label May 4, 2026
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick comments (5)
docs/get-started/windows-preparation.md (1)

106-106: 💤 Low value

Consider using consistent terminology for the onboarding wizard.

Other documentation files refer to the "onboard wizard" with inline code formatting.
For consistency, consider:

-If Ollama is installed but not already running in WSL, the onboarding process starts it for you.
+If Ollama is installed but not already running in WSL, the `onboard` wizard starts it for you.

As per coding guidelines, CLI commands and component names should use inline code formatting, and consistent terminology improves clarity across documentation.

🤖 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/get-started/windows-preparation.md` at line 106, The sentence uses plain
text "onboarding process" but other docs refer to the `onboard` wizard with
inline code formatting; update this sentence to use the same terminology and
inline code formatting (e.g., replace "the onboarding process starts it for you"
with "the `onboard` wizard starts it for you") to keep CLI/component names
consistent across docs.
docs/get-started/quickstart.md (2)

188-188: ⚡ Quick win

Use one sentence per line in source.

Line 188 contains two sentences.
Split them for better diff readability.

-Routes inference to a local Ollama instance. Depending on your platform, the wizard can use an existing daemon, start an installed daemon, or offer an install action.
+Routes inference to a local Ollama instance.
+Depending on your platform, the wizard can use an existing daemon, start an installed daemon, or offer an install action.

As per coding guidelines, one sentence per line in source makes diffs readable.

🤖 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/get-started/quickstart.md` at line 188, The sentence pair "Routes
inference to a local Ollama instance. Depending on your platform, the wizard can
use an existing daemon, start an installed daemon, or offer an install action."
should be split into two separate lines in the source so each sentence is on its
own line; edit the paragraph in quickstart.md to place "Routes inference to a
local Ollama instance." on its own line and the following sentence "Depending on
your platform, the wizard can use an existing daemon, start an installed daemon,
or offer an install action." on the next line to follow the
one-sentence-per-line guideline.

190-190: ⚡ Quick win

Use one sentence per line in source.

Line 190 contains two sentences.
Split them for better diff readability.

-No API key is required. On non-WSL hosts, NemoClaw generates a token and starts an authenticated proxy so containers can reach Ollama without exposing the daemon directly to your network.
+No API key is required.
+On non-WSL hosts, NemoClaw generates a token and starts an authenticated proxy so containers can reach Ollama without exposing the daemon directly to your network.

As per coding guidelines, one sentence per line in source makes diffs readable.

🤖 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/get-started/quickstart.md` at line 190, The sentence "No API key is
required. On non-WSL hosts, NemoClaw generates a token and starts an
authenticated proxy so containers can reach Ollama without exposing the daemon
directly to your network." should be split into two lines so each sentence is on
its own line in docs/get-started/quickstart.md; edit the paragraph containing
that sentence (search for the exact text "No API key is required.") and place a
newline after the first sentence so "No API key is required." is one line and
the remaining sentence starts the next line.
docs/inference/use-local-inference.md (2)

83-83: ⚡ Quick win

Use inline code formatting for CLI commands.

The term onboard should use inline code formatting since it refers to the CLI wizard command.

-For non-WSL Ollama setups, the onboard wizard manages the proxy automatically:
+For non-WSL Ollama setups, the `onboard` wizard manages the proxy automatically:

As per coding guidelines, CLI commands, file paths, flags, parameter names, and values must use inline code formatting.

🤖 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/inference/use-local-inference.md` at line 83, Replace the plain text
"onboard wizard" with inline code formatting for the CLI command by changing it
to "`onboard` wizard" in the sentence "For non-WSL Ollama setups, the onboard
wizard manages the proxy automatically:" and ensure any other CLI commands,
flags, file paths or parameter names in that sentence use inline `code`
formatting to follow the documentation style guide.

38-38: ⚡ Quick win

Use inline code formatting for CLI commands and component names.

The term onboard should use inline code formatting since it refers to the CLI wizard command.

-- A local model server running, or an Ollama setup that the NemoClaw onboard wizard can use, start, or install.
+- A local model server running, or an Ollama setup that the NemoClaw `onboard` wizard can use, start, or install.

As per coding guidelines, CLI commands, file paths, flags, parameter names, and values must use inline code formatting.

🤖 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/inference/use-local-inference.md` at line 38, Update the sentence "A
local model server running, or an Ollama setup that the NemoClaw onboard wizard
can use, start, or install." to use inline code formatting for CLI commands and
component names: wrap `onboard` (the CLI wizard command) in backticks, and also
wrap component/CLI references like `Ollama` and `NemoClaw` or any CLI
flags/paths mentioned in code style; ensure the sentence reads with those names
and commands formatted as inline `code`.
🤖 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/get-started/quickstart.md`:
- Line 188: The sentence pair "Routes inference to a local Ollama instance.
Depending on your platform, the wizard can use an existing daemon, start an
installed daemon, or offer an install action." should be split into two separate
lines in the source so each sentence is on its own line; edit the paragraph in
quickstart.md to place "Routes inference to a local Ollama instance." on its own
line and the following sentence "Depending on your platform, the wizard can use
an existing daemon, start an installed daemon, or offer an install action." on
the next line to follow the one-sentence-per-line guideline.
- Line 190: The sentence "No API key is required. On non-WSL hosts, NemoClaw
generates a token and starts an authenticated proxy so containers can reach
Ollama without exposing the daemon directly to your network." should be split
into two lines so each sentence is on its own line in
docs/get-started/quickstart.md; edit the paragraph containing that sentence
(search for the exact text "No API key is required.") and place a newline after
the first sentence so "No API key is required." is one line and the remaining
sentence starts the next line.

In `@docs/get-started/windows-preparation.md`:
- Line 106: The sentence uses plain text "onboarding process" but other docs
refer to the `onboard` wizard with inline code formatting; update this sentence
to use the same terminology and inline code formatting (e.g., replace "the
onboarding process starts it for you" with "the `onboard` wizard starts it for
you") to keep CLI/component names consistent across docs.

In `@docs/inference/use-local-inference.md`:
- Line 83: Replace the plain text "onboard wizard" with inline code formatting
for the CLI command by changing it to "`onboard` wizard" in the sentence "For
non-WSL Ollama setups, the onboard wizard manages the proxy automatically:" and
ensure any other CLI commands, flags, file paths or parameter names in that
sentence use inline `code` formatting to follow the documentation style guide.
- Line 38: Update the sentence "A local model server running, or an Ollama setup
that the NemoClaw onboard wizard can use, start, or install." to use inline code
formatting for CLI commands and component names: wrap `onboard` (the CLI wizard
command) in backticks, and also wrap component/CLI references like `Ollama` and
`NemoClaw` or any CLI flags/paths mentioned in code style; ensure the sentence
reads with those names and commands formatted as inline `code`.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 5daa80ac-914c-45d5-9246-24253c793428

📥 Commits

Reviewing files that changed from the base of the PR and between 7d5cdd4 and fd33f55.

📒 Files selected for processing (6)
  • docs/deployment/deploy-to-remote-gpu.md
  • docs/get-started/quickstart.md
  • docs/get-started/windows-preparation.md
  • docs/inference/use-local-inference.md
  • docs/reference/commands.md
  • docs/reference/troubleshooting.md

@miyoungc miyoungc added v0.0.34 Release target and removed v0.0.33 Release target labels May 4, 2026
@miyoungc miyoungc marked this pull request as draft May 4, 2026 22:34
@copy-pr-bot
Copy link
Copy Markdown

copy-pr-bot Bot commented May 4, 2026

Auto-sync is disabled for draft pull requests in this repository. Workflows must be run manually.

Contributors can view more details about this message here.

miyoungc and others added 3 commits May 4, 2026 16:34
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
@miyoungc miyoungc marked this pull request as ready for review May 4, 2026 23:44
@miyoungc miyoungc changed the title docs: catch up weekend user-facing changes docs: refresh documentation and user-skills for 0.0.34 May 4, 2026
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
docs/reference/commands.md (1)

308-316: ⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Fix the state-count mismatch in the status section.

Line 308 says the command reports “one of three states,” but the table now lists four states (healthy, unreachable, not probed, not verified). Please update the sentence to avoid contradictory behavior docs.

Suggested edit
-The command probes every inference provider and reports one of three states on the `Inference` line:
+The command probes every inference provider and reports one of four states on the `Inference` 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/reference/commands.md` around lines 308 - 316, Update the sentence that
currently states the command "probes every inference provider and reports one of
three states on the `Inference` line" to reflect the four entries in the table;
specifically change it to say "one of four states" (or reword to "one of several
states") so it matches the listed states `healthy`, `unreachable`, `not probed`,
and `not verified` shown under the `Inference` line in the status section.
🧹 Nitpick comments (1)
.agents/skills/nemoclaw-user-manage-policy/SKILL.md (1)

1-288: 💤 Low value

Autogenerated skill documentation updated as expected.

This file was correctly regenerated from docs/ source per the PR workflow. The comprehensive network policy customization guide is well-structured and covers static changes, dynamic updates, presets, and custom preset authoring.

Minor capitalization issue in preset table: Line 171 uses lowercase "github" in the table; it should be "GitHub" per the official brand name. Since this file is autogenerated, apply the fix to the corresponding source file in docs/ and regenerate. Based on learnings, changes to .agents/skills/ files are autogenerated from docs/ by docs-to-skills.py and should be fixed at the source.

🤖 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 @.agents/skills/nemoclaw-user-manage-policy/SKILL.md around lines 1 - 288,
The autogenerated skill doc has a lowercase preset entry "github" in the
"Available presets" table that should use the official capitalization "GitHub";
update the corresponding source docs entry (the preset name/label in the docs
source that generates the presets table, e.g., the preset key/value for github)
to "GitHub" and then re-run the docs-to-skills.py generation so the change
propagates into .agents/skills/nemoclaw-user-manage-policy/SKILL.md; ensure the
preset identifier remains the same for programmatic use but fix the human-facing
display text to "GitHub" in the source.
🤖 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/workspace-files.md`:
- Around line 100-102: The doc and code disagree: the implementation in
src/nemoclaw.ts checks backup.success and always aborts (calls bail()) even when
backup.backedUpDirs.length > 0, so update the documentation in
docs/manage-sandboxes/workspace-files.md to reflect that rebuild aborts on any
backup failure (i.e., NemoClaw does not continue with partial backups) and
reword the sentence to use active voice (replace "was saved" with "saved" or
similar active phrasing); alternatively, if you prefer to change behavior
instead, modify the logic around backup.success in the rebuild flow to allow
continuation when backup.backedUpDirs.length > 0 by skipping bail() and
proceeding with restoring only verified entries—but pick one approach and make
the doc and code consistent.

---

Outside diff comments:
In `@docs/reference/commands.md`:
- Around line 308-316: Update the sentence that currently states the command
"probes every inference provider and reports one of three states on the
`Inference` line" to reflect the four entries in the table; specifically change
it to say "one of four states" (or reword to "one of several states") so it
matches the listed states `healthy`, `unreachable`, `not probed`, and `not
verified` shown under the `Inference` line in the status section.

---

Nitpick comments:
In @.agents/skills/nemoclaw-user-manage-policy/SKILL.md:
- Around line 1-288: The autogenerated skill doc has a lowercase preset entry
"github" in the "Available presets" table that should use the official
capitalization "GitHub"; update the corresponding source docs entry (the preset
name/label in the docs source that generates the presets table, e.g., the preset
key/value for github) to "GitHub" and then re-run the docs-to-skills.py
generation so the change propagates into
.agents/skills/nemoclaw-user-manage-policy/SKILL.md; ensure the preset
identifier remains the same for programmatic use but fix the human-facing
display text to "GitHub" in the source.
🪄 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: ff78b0b9-9c54-43b9-aeac-2bcc6c906d66

📥 Commits

Reviewing files that changed from the base of the PR and between fd33f55 and 41abed8.

📒 Files selected for processing (27)
  • .agents/skills/nemoclaw-skills-guide/SKILL.md
  • .agents/skills/nemoclaw-user-agent-skills/references/agent-skills.md
  • .agents/skills/nemoclaw-user-configure-inference/SKILL.md
  • .agents/skills/nemoclaw-user-configure-inference/references/inference-options.md
  • .agents/skills/nemoclaw-user-configure-inference/references/set-up-sub-agent.md
  • .agents/skills/nemoclaw-user-configure-inference/references/switch-inference-providers.md
  • .agents/skills/nemoclaw-user-deploy-remote/SKILL.md
  • .agents/skills/nemoclaw-user-get-started/SKILL.md
  • .agents/skills/nemoclaw-user-get-started/references/quickstart-hermes.md
  • .agents/skills/nemoclaw-user-get-started/references/windows-preparation.md
  • .agents/skills/nemoclaw-user-manage-policy/SKILL.md
  • .agents/skills/nemoclaw-user-manage-policy/references/approve-network-requests.md
  • .agents/skills/nemoclaw-user-manage-sandboxes/SKILL.md
  • .agents/skills/nemoclaw-user-manage-sandboxes/references/backup-restore.md
  • .agents/skills/nemoclaw-user-manage-sandboxes/references/messaging-channels.md
  • .agents/skills/nemoclaw-user-manage-sandboxes/references/workspace-files.md
  • .agents/skills/nemoclaw-user-reference/SKILL.md
  • .agents/skills/nemoclaw-user-reference/references/cli-selection-guide.md
  • .agents/skills/nemoclaw-user-reference/references/commands.md
  • .agents/skills/nemoclaw-user-reference/references/network-policies.md
  • .agents/skills/nemoclaw-user-reference/references/troubleshooting.md
  • docs/manage-sandboxes/lifecycle.md
  • docs/manage-sandboxes/workspace-files.md
  • docs/project.json
  • docs/reference/commands.md
  • docs/resources/agent-skills.md
  • docs/versions1.json
✅ Files skipped from review due to trivial changes (13)
  • docs/project.json
  • docs/versions1.json
  • .agents/skills/nemoclaw-user-reference/SKILL.md
  • docs/resources/agent-skills.md
  • .agents/skills/nemoclaw-user-reference/references/network-policies.md
  • .agents/skills/nemoclaw-user-configure-inference/references/switch-inference-providers.md
  • .agents/skills/nemoclaw-user-get-started/references/windows-preparation.md
  • .agents/skills/nemoclaw-user-manage-policy/references/approve-network-requests.md
  • .agents/skills/nemoclaw-user-get-started/references/quickstart-hermes.md
  • .agents/skills/nemoclaw-user-configure-inference/references/inference-options.md
  • docs/manage-sandboxes/lifecycle.md
  • .agents/skills/nemoclaw-skills-guide/SKILL.md
  • .agents/skills/nemoclaw-user-manage-sandboxes/SKILL.md

Comment thread docs/manage-sandboxes/workspace-files.md Outdated
Co-authored-by: Cursor <cursoragent@cursor.com>
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (2)
docs/manage-sandboxes/lifecycle.md (2)

256-258: ⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Use console language tag with $ prompt for CLI examples.

This CLI command example uses the bash language identifier, but the style guide requires console with a $ prompt prefix for all CLI examples.

As per coding guidelines, CLI code blocks must use the console language tag with $ prompt prefix.

Proposed fix
-```bash
-nemoclaw uninstall
-```
+```console
+$ nemoclaw uninstall
+```
🤖 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/lifecycle.md` around lines 256 - 258, Replace the bash
code block containing the CLI example for the command "nemoclaw uninstall" with
a console code block and add the prompt prefix; specifically, change the fenced
block language from bash to console and prepend the command with "$ " so the
block shows "$ nemoclaw uninstall" instead of just "nemoclaw uninstall".

270-272: ⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Use console language tag with $ prompt for CLI examples.

This CLI command example uses the bash language identifier, but the style guide requires console with a $ prompt prefix for all CLI examples.

As per coding guidelines, CLI code blocks must use the console language tag with $ prompt prefix.

Proposed fix
-```bash
-curl -fsSL https://raw.githubusercontent.com/NVIDIA/NemoClaw/refs/heads/main/uninstall.sh | bash
-```
+```console
+$ curl -fsSL https://raw.githubusercontent.com/NVIDIA/NemoClaw/refs/heads/main/uninstall.sh | bash
+```
🤖 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/lifecycle.md` around lines 270 - 272, Replace the code
block language tag "bash" with "console" and prefix the command line with a "$"
prompt in the snippet shown in docs/manage-sandboxes/lifecycle.md so the CLI
example follows the style guide; specifically change the fenced code block
header from ```bash to ```console and add a leading "$ " before the curl command
inside the block.
🧹 Nitpick comments (1)
docs/manage-sandboxes/lifecycle.md (1)

239-239: ⚡ Quick win

Use active voice.

The phrase "if any manifest-defined state path cannot be copied" uses passive voice.

As per coding guidelines, active voice is required throughout documentation.

Suggested rewrite
-The flow refuses to proceed past preflight if a credential is missing or past backup if any manifest-defined state path cannot be copied, so a failed run leaves the original sandbox intact and ready to retry.
+The flow refuses to proceed past preflight if a credential is missing or past backup if NemoClaw cannot copy any manifest-defined state path, so a failed run leaves the original sandbox intact and ready to retry.
🤖 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/lifecycle.md` at line 239, Rewrite the passive clause
"if any manifest-defined state path cannot be copied" into active voice; update
the sentence to read something like: "The flow refuses to proceed past preflight
if a credential is missing or past backup if we cannot copy any manifest-defined
state path." Edit the line in lifecycle.md replacing the passive fragment with
an active-subject construction ("we cannot copy" or "the process cannot copy")
while preserving the original meaning.
🤖 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.

Outside diff comments:
In `@docs/manage-sandboxes/lifecycle.md`:
- Around line 256-258: Replace the bash code block containing the CLI example
for the command "nemoclaw uninstall" with a console code block and add the
prompt prefix; specifically, change the fenced block language from bash to
console and prepend the command with "$ " so the block shows "$ nemoclaw
uninstall" instead of just "nemoclaw uninstall".
- Around line 270-272: Replace the code block language tag "bash" with "console"
and prefix the command line with a "$" prompt in the snippet shown in
docs/manage-sandboxes/lifecycle.md so the CLI example follows the style guide;
specifically change the fenced code block header from ```bash to ```console and
add a leading "$ " before the curl command inside the block.

---

Nitpick comments:
In `@docs/manage-sandboxes/lifecycle.md`:
- Line 239: Rewrite the passive clause "if any manifest-defined state path
cannot be copied" into active voice; update the sentence to read something like:
"The flow refuses to proceed past preflight if a credential is missing or past
backup if we cannot copy any manifest-defined state path." Edit the line in
lifecycle.md replacing the passive fragment with an active-subject construction
("we cannot copy" or "the process cannot copy") while preserving the original
meaning.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: d1c4f212-2baa-45ab-87c0-a83bd3ea8ea5

📥 Commits

Reviewing files that changed from the base of the PR and between 41abed8 and 034c031.

📒 Files selected for processing (6)
  • .agents/skills/nemoclaw-user-manage-sandboxes/SKILL.md
  • .agents/skills/nemoclaw-user-manage-sandboxes/references/workspace-files.md
  • .agents/skills/nemoclaw-user-reference/references/commands.md
  • docs/manage-sandboxes/lifecycle.md
  • docs/manage-sandboxes/workspace-files.md
  • docs/reference/commands.md
✅ Files skipped from review due to trivial changes (3)
  • docs/reference/commands.md
  • .agents/skills/nemoclaw-user-reference/references/commands.md
  • .agents/skills/nemoclaw-user-manage-sandboxes/references/workspace-files.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • .agents/skills/nemoclaw-user-manage-sandboxes/SKILL.md

@miyoungc miyoungc merged commit 64dd957 into main May 5, 2026
23 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation v0.0.34 Release target

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants