## Summary
- Adds a new `## Update to the Latest Version` H2 section to
[`docs/get-started/quickstart.md`](https://github.com/NVIDIA/NemoClaw/blob/main/docs/get-started/quickstart.md),
positioned between *Chat with the Agent* and *Uninstall*.
- Covers the two steps a user needs to upgrade an existing install:
re-run the installer (CLI update) and `nemoclaw upgrade-sandboxes` (bulk
rebuild of stale sandbox images).
- Calls out the `nemoclaw backup-all` that the installer runs
automatically so users understand the built-in safety net, plus a
`{tip}` admonition for a manual `snapshot create` / `snapshot restore`
rollback on schema-breaking releases.
## Problem
Users asking how to update NemoClaw have to piece the flow together from
three disconnected places:
1.
[`docs/reference/commands.md`](https://github.com/NVIDIA/NemoClaw/blob/main/docs/reference/commands.md)
has reference entries for `rebuild`, `upgrade-sandboxes`, `backup-all`,
and `snapshot create/list/restore`, but reference-style flag tables
aren't a walkthrough.
2.
[`docs/workspace/backup-restore.md`](https://github.com/NVIDIA/NemoClaw/blob/main/docs/workspace/backup-restore.md)
says to back up *"Before major NemoClaw version upgrades"* but never
shows what upgrading actually looks like.
3.
[`docs/reference/troubleshooting.md`](https://github.com/NVIDIA/NemoClaw/blob/main/docs/reference/troubleshooting.md)
mentions re-running the installer only in error-recovery contexts.
Most notably, `nemoclaw upgrade-sandboxes` (the command purpose-built
for the upgrade scenario) is documented in the command reference but not
referenced from any tutorial, how-to, or quickstart page. A user who
only reads `quickstart.md` has no guided path from *"a new release came
out"* to *"my sandbox is on it"*.
No `docs/**/*upgrade*` or `docs/**/*update*` file exists.
## Change
New 38-line H2 section in `quickstart.md` that:
- Frames the two things that move on a new release — the host CLI and
the sandbox base image — and why both need updating.
- Shows the installer re-run command and notes that `backup-all` runs
automatically before onboarding.
- Shows `upgrade-sandboxes` with its three common invocations
(`--check`, default, `--auto`) and explicitly cross-links to the
existing `rebuild` reference entry so the state-preservation guarantees
(workspace files, credentials, policy presets) are documented in one
place only.
- Adds a `{tip}` block for manual `snapshot create` / `snapshot restore`
when a release notes mentions schema or compatibility breaks.
Every command mention cross-links to its existing anchor in
[`docs/reference/commands.md`](https://github.com/NVIDIA/NemoClaw/blob/main/docs/reference/commands.md)
so flag details are not duplicated and anchor slugs
(`nemoclaw-name-rebuild`, `nemoclaw-upgrade-sandboxes`,
`nemoclaw-backup-all`, `nemoclaw-name-snapshot-create`) follow the
existing MyST convention used in #2224.
## Test plan
- [x] `markdownlint-cli2 docs/get-started/quickstart.md` clean (0
errors).
- [x] All cross-link anchors verified present in
`docs/reference/commands.md`:
- `#nemoclaw-backup-all` — line 468
- `#nemoclaw-upgrade-sandboxes` — line 449
- `#nemoclaw-name-rebuild` — line 427
- `#nemoclaw-name-snapshot-create` — line 479
- [x] Cross-link to `../workspace/backup-restore.md` verified.
- [x] `commitlint` passes on the commit header (under 100 chars).
- [x] DCO trailer present, SSH-signed.
Signed-off-by: latenighthackathon
<latenighthackathon@users.noreply.github.com>
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit
* **Documentation**
* New Quickstart for keeping NemoClaw current: re-run the installer to
refresh the CLI and create an automatic safety backup.
* Documented sandbox upgrade flow: detect stale sandboxes, check mode,
interactive confirm or unattended (--auto) rebuild, and automatic
reapplication of workspace files, credentials, and policy presets.
* Clarified rebuild/rollback semantics: old container replaced,
workspace preserved, non-workspace/in-memory state not preserved;
restore via snapshot.
* Added preflight/backup abort guidance and troubleshooting for missing
credentials.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
---------
Signed-off-by: latenighthackathon <latenighthackathon@users.noreply.github.com>
Co-authored-by: latenighthackathon <latenighthackathon@users.noreply.github.com>