From 9624d81bb34ce008ad508ada7323f35572427352 Mon Sep 17 00:00:00 2001 From: Vincent Koc Date: Sun, 26 Apr 2026 21:59:23 -0700 Subject: [PATCH] docs(install): batch convert callouts and sentence-case headings - macos-vm: download-time Note component - hetzner: community-maintained Note component - exe-dev: stateful-VM Tip component - development-channels: parallel clones Tip component - migrating: sentence-case top heading and section headings, replace bullet -- separators with em-dashes, drop 'this guide' filler --- docs/install/development-channels.md | 5 +++-- docs/install/exe-dev.md | 6 +++--- docs/install/hetzner.md | 4 +++- docs/install/macos-vm.md | 4 +++- docs/install/migrating.md | 22 +++++++++++----------- 5 files changed, 23 insertions(+), 18 deletions(-) diff --git a/docs/install/development-channels.md b/docs/install/development-channels.md index 1d38f82bbd6..1a97dbfecce 100644 --- a/docs/install/development-channels.md +++ b/docs/install/development-channels.md @@ -46,8 +46,9 @@ install method: `OPENCLAW_GIT_DIR`), switches to `main`, rebases on upstream, builds, and installs the global CLI from that checkout. -Tip: if you want stable + dev in parallel, keep two clones and point your -gateway at the stable one. + +If you want stable and dev in parallel, keep two clones and point your gateway at the stable one. + ## One-off version or tag targeting diff --git a/docs/install/exe-dev.md b/docs/install/exe-dev.md index 0f3ba0f574a..00b8639d13c 100644 --- a/docs/install/exe-dev.md +++ b/docs/install/exe-dev.md @@ -48,9 +48,9 @@ Then connect: ssh .exe.xyz ``` -Tip: keep this VM **stateful**. OpenClaw stores `openclaw.json`, per-agent -`auth-profiles.json`, sessions, and channel/provider state under -`~/.openclaw/`, plus the workspace under `~/.openclaw/workspace/`. + +Keep this VM **stateful**. OpenClaw stores `openclaw.json`, per-agent `auth-profiles.json`, sessions, and channel/provider state under `~/.openclaw/`, plus the workspace under `~/.openclaw/workspace/`. + ## 2) Install prerequisites (on the VM) diff --git a/docs/install/hetzner.md b/docs/install/hetzner.md index aaa19aea56e..fce0db56f39 100644 --- a/docs/install/hetzner.md +++ b/docs/install/hetzner.md @@ -253,7 +253,9 @@ For teams preferring infrastructure-as-code workflows, a community-maintained Te This approach complements the Docker setup above with reproducible deployments, version-controlled infrastructure, and automated disaster recovery. -> **Note:** Community-maintained. For issues or contributions, see the repository links above. + +Community-maintained. For issues or contributions, see the repository links above. + ## Next steps diff --git a/docs/install/macos-vm.md b/docs/install/macos-vm.md index 2e4fd5184f1..18300b19e64 100644 --- a/docs/install/macos-vm.md +++ b/docs/install/macos-vm.md @@ -92,7 +92,9 @@ lume create openclaw --os macos --ipsw latest This downloads macOS and creates the VM. A VNC window opens automatically. -Note: The download can take a while depending on your connection. + +The download can take a while depending on your connection. + --- diff --git a/docs/install/migrating.md b/docs/install/migrating.md index a08b279849a..e970de30d20 100644 --- a/docs/install/migrating.md +++ b/docs/install/migrating.md @@ -6,26 +6,26 @@ read_when: title: "Migration guide" --- -# Migrating OpenClaw to a New Machine +# Migrating OpenClaw to a new machine -This guide moves an OpenClaw gateway to a new machine without redoing onboarding. +Move an OpenClaw gateway to a new machine without redoing onboarding. -## What Gets Migrated +## What gets migrated When you copy the **state directory** (`~/.openclaw/` by default) and your **workspace**, you preserve: -- **Config** -- `openclaw.json` and all gateway settings -- **Auth** -- per-agent `auth-profiles.json` (API keys + OAuth), plus any channel/provider state under `credentials/` -- **Sessions** -- conversation history and agent state -- **Channel state** -- WhatsApp login, Telegram session, etc. -- **Workspace files** -- `MEMORY.md`, `USER.md`, skills, and prompts +- **Config** — `openclaw.json` and all gateway settings. +- **Auth** — per-agent `auth-profiles.json` (API keys plus OAuth), plus any channel or provider state under `credentials/`. +- **Sessions** — conversation history and agent state. +- **Channel state** — WhatsApp login, Telegram session, and similar. +- **Workspace files** — `MEMORY.md`, `USER.md`, skills, and prompts. Run `openclaw status` on the old machine to confirm your state directory path. Custom profiles use `~/.openclaw-/` or a path set via `OPENCLAW_STATE_DIR`. -## Migration Steps +## Migration steps @@ -70,7 +70,7 @@ Custom profiles use `~/.openclaw-/` or a path set via `OPENCLAW_STATE_D -## Common Pitfalls +## Common pitfalls @@ -102,7 +102,7 @@ Custom profiles use `~/.openclaw-/` or a path set via `OPENCLAW_STATE_D -## Verification Checklist +## Verification checklist On the new machine, confirm: