From b23232d560e9d787dc3e52f747c05210dda0cbe7 Mon Sep 17 00:00:00 2001 From: Vincent Koc Date: Tue, 5 May 2026 22:24:47 -0700 Subject: [PATCH] docs: typography hygiene across 6 pages (mac platform + sandbox/wizard) --- docs/gateway/sandbox-vs-tool-policy-vs-elevated.md | 8 ++++---- docs/platforms/mac/icon.md | 6 +++--- docs/platforms/mac/logging.md | 6 +++--- docs/platforms/mac/voicewake.md | 6 +++--- docs/platforms/mac/webchat.md | 6 +++--- docs/reference/wizard.md | 6 +++--- 6 files changed, 19 insertions(+), 19 deletions(-) diff --git a/docs/gateway/sandbox-vs-tool-policy-vs-elevated.md b/docs/gateway/sandbox-vs-tool-policy-vs-elevated.md index 291ab98e753..18731983774 100644 --- a/docs/gateway/sandbox-vs-tool-policy-vs-elevated.md +++ b/docs/gateway/sandbox-vs-tool-policy-vs-elevated.md @@ -9,7 +9,7 @@ OpenClaw has three related (but different) controls: 1. **Sandbox** (`agents.defaults.sandbox.*` / `agents.list[].sandbox.*`) decides **where tools run** (sandbox backend vs host). 2. **Tool policy** (`tools.*`, `tools.sandbox.tools.*`, `agents.list[].tools.*`) decides **which tools are available/allowed**. -3. **Elevated** (`tools.elevated.*`, `agents.list[].tools.elevated.*`) is an **exec-only escape hatch** to run outside the sandbox when you’re sandboxed (`gateway` by default, or `node` when the exec target is configured to `node`). +3. **Elevated** (`tools.elevated.*`, `agents.list[].tools.elevated.*`) is an **exec-only escape hatch** to run outside the sandbox when you're sandboxed (`gateway` by default, or `node` when the exec target is configured to `node`). ## Quick debug @@ -34,7 +34,7 @@ It prints: Sandboxing is controlled by `agents.defaults.sandbox.mode`: - `"off"`: everything runs on the host. -- `"non-main"`: only non-main sessions are sandboxed (common “surprise” for groups/channels). +- `"non-main"`: only non-main sessions are sandboxed (common "surprise" for groups/channels). - `"all"`: everything is sandboxed. See [Sandboxing](/gateway/sandboxing) for the full matrix (scope, workspace mounts, images). @@ -103,9 +103,9 @@ Available groups: Elevated does **not** grant extra tools; it only affects `exec`. -- If you’re sandboxed, `/elevated on` (or `exec` with `elevated: true`) runs outside the sandbox (approvals may still apply). +- If you're sandboxed, `/elevated on` (or `exec` with `elevated: true`) runs outside the sandbox (approvals may still apply). - Use `/elevated full` to skip exec approvals for the session. -- If you’re already running direct, elevated is effectively a no-op (still gated). +- If you're already running direct, elevated is effectively a no-op (still gated). - Elevated is **not** skill-scoped and does **not** override tool allow/deny. - Elevated does not grant arbitrary cross-host overrides from `host=auto`; it follows the normal exec target rules and only preserves `node` when the configured/session target is already `node`. - `/exec` is separate from elevated. It only adjusts per-session exec defaults for authorized senders. diff --git a/docs/platforms/mac/icon.md b/docs/platforms/mac/icon.md index 4f4e481d41a..c5a14621e11 100644 --- a/docs/platforms/mac/icon.md +++ b/docs/platforms/mac/icon.md @@ -12,7 +12,7 @@ Author: steipete · Updated: 2025-12-06 · Scope: macOS app (`apps/macos`) - **Idle:** Normal icon animation (blink, occasional wiggle). - **Paused:** Status item uses `appearsDisabled`; no motion. - **Voice trigger (big ears):** Voice wake detector calls `AppState.triggerVoiceEars(ttl: nil)` when the wake word is heard, keeping `earBoostActive=true` while the utterance is captured. Ears scale up (1.9x), get circular ear holes for readability, then drop via `stopVoiceEars()` after 1s of silence. Only fired from the in-app voice pipeline. -- **Working (agent running):** `AppState.isWorking=true` drives a “tail/leg scurry” micro-motion: faster leg wiggle and slight offset while work is in-flight. Currently toggled around WebChat agent runs; add the same toggle around other long tasks when you wire them. +- **Working (agent running):** `AppState.isWorking=true` drives a "tail/leg scurry" micro-motion: faster leg wiggle and slight offset while work is in-flight. Currently toggled around WebChat agent runs; add the same toggle around other long tasks when you wire them. Wiring points @@ -23,11 +23,11 @@ Shapes & sizes - Base icon drawn in `CritterIconRenderer.makeIcon(blink:legWiggle:earWiggle:earScale:earHoles:)`. - Ear scale defaults to `1.0`; voice boost sets `earScale=1.9` and toggles `earHoles=true` without changing overall frame (18×18 pt template image rendered into a 36×36 px Retina backing store). -- Scurry uses leg wiggle up to ~1.0 with a small horizontal jiggle; it’s additive to any existing idle wiggle. +- Scurry uses leg wiggle up to ~1.0 with a small horizontal jiggle; it's additive to any existing idle wiggle. Behavioral notes -- No external CLI/broker toggle for ears/working; keep it internal to the app’s own signals to avoid accidental flapping. +- No external CLI/broker toggle for ears/working; keep it internal to the app's own signals to avoid accidental flapping. - Keep TTLs short (<10s) so the icon returns to baseline quickly if a job hangs. ## Related diff --git a/docs/platforms/mac/logging.md b/docs/platforms/mac/logging.md index 591e302f8f6..2bb910493c0 100644 --- a/docs/platforms/mac/logging.md +++ b/docs/platforms/mac/logging.md @@ -13,14 +13,14 @@ title: "macOS logging" OpenClaw routes macOS app logs through swift-log (unified logging by default) and can write a local, rotating file log to disk when you need a durable capture. - Verbosity: **Debug pane → Logs → App logging → Verbosity** -- Enable: **Debug pane → Logs → App logging → “Write rolling diagnostics log (JSONL)”** +- Enable: **Debug pane → Logs → App logging → "Write rolling diagnostics log (JSONL)"** - Location: `~/Library/Logs/OpenClaw/diagnostics.jsonl` (rotates automatically; old files are suffixed with `.1`, `.2`, …) -- Clear: **Debug pane → Logs → App logging → “Clear”** +- Clear: **Debug pane → Logs → App logging → "Clear"** Notes: - This is **off by default**. Enable only while actively debugging. -- Treat the file as sensitive; don’t share it without review. +- Treat the file as sensitive; don't share it without review. ## Unified logging private data on macOS diff --git a/docs/platforms/mac/voicewake.md b/docs/platforms/mac/voicewake.md index d5446a6efb4..5494f7e4e09 100644 --- a/docs/platforms/mac/voicewake.md +++ b/docs/platforms/mac/voicewake.md @@ -15,7 +15,7 @@ title: "Voice wake (macOS)" ## Runtime behavior (wake-word) - Speech recognizer lives in `VoiceWakeRuntime`. -- Trigger only fires when there’s a **meaningful pause** between the wake word and the next word (~0.55s gap). The overlay/chime can start on the pause even before the command begins. +- Trigger only fires when there's a **meaningful pause** between the wake word and the next word (~0.55s gap). The overlay/chime can start on the pause even before the command begins. - Silence windows: 2.0s when speech is flowing, 5.0s if only the trigger was heard. - Hard stop: 120s to prevent runaway sessions. - Debounce between sessions: 350ms. @@ -29,7 +29,7 @@ title: "Voice wake (macOS)" ## Sticky overlay failure mode (previous) -Previously, if the overlay got stuck visible and you manually closed it, Voice Wake could appear “dead” because the runtime’s restart attempt could be blocked by overlay visibility and no subsequent restart was scheduled. +Previously, if the overlay got stuck visible and you manually closed it, Voice Wake could appear "dead" because the runtime's restart attempt could be blocked by overlay visibility and no subsequent restart was scheduled. Hardening: @@ -50,7 +50,7 @@ Hardening: - **Hold Cmd+Fn to talk**: enables the push-to-talk monitor. Disabled on macOS < 26. - Language & mic pickers, live level meter, trigger-word table, tester (local-only; does not forward). - Mic picker preserves the last selection if a device disconnects, shows a disconnected hint, and temporarily falls back to the system default until it returns. -- **Sounds**: chimes on trigger detect and on send; defaults to the macOS “Glass” system sound. You can pick any `NSSound`-loadable file (e.g. MP3/WAV/AIFF) for each event or choose **No Sound**. +- **Sounds**: chimes on trigger detect and on send; defaults to the macOS "Glass" system sound. You can pick any `NSSound`-loadable file (e.g. MP3/WAV/AIFF) for each event or choose **No Sound**. ## Forwarding behavior diff --git a/docs/platforms/mac/webchat.md b/docs/platforms/mac/webchat.md index 8cf5e7bf9ee..2a740e19d62 100644 --- a/docs/platforms/mac/webchat.md +++ b/docs/platforms/mac/webchat.md @@ -15,8 +15,8 @@ agent (with a session switcher for other sessions). ## Launch and debugging -- Manual: Lobster menu → “Open Chat”. -- Auto‑open for testing: +- Manual: Lobster menu → "Open Chat". +- Auto-open for testing: ```bash dist/OpenClaw.app/Contents/MacOS/OpenClaw --webchat @@ -38,7 +38,7 @@ agent (with a session switcher for other sessions). omitted, and oversized rows can be replaced with placeholders. - Session: defaults to the primary session (`main`, or `global` when scope is global). The UI can switch between sessions. -- Onboarding uses a dedicated session to keep first‑run setup separate. +- Onboarding uses a dedicated session to keep first-run setup separate. ## Security surface diff --git a/docs/reference/wizard.md b/docs/reference/wizard.md index a27d82dc21f..902f732a6b2 100644 --- a/docs/reference/wizard.md +++ b/docs/reference/wizard.md @@ -92,7 +92,7 @@ For a high-level overview, see [Onboarding (CLI)](/start/wizard). - Requires a non-empty env var in the onboarding process environment. - Cannot be combined with `--gateway-token`. - Disable auth only if you fully trust every local process. - - Non‑loopback binds still require auth. + - Non-loopback binds still require auth. @@ -164,7 +164,7 @@ openclaw onboard --non-interactive \ --skip-skills ``` -Add `--json` for a machine‑readable summary. +Add `--json` for a machine-readable summary. Gateway token SecretRef in non-interactive mode: @@ -200,7 +200,7 @@ openclaw agents add work \ ## Gateway wizard RPC The Gateway exposes the onboarding flow over RPC (`wizard.start`, `wizard.next`, `wizard.cancel`, `wizard.status`). -Clients (macOS app, Control UI) can render steps without re‑implementing onboarding logic. +Clients (macOS app, Control UI) can render steps without re-implementing onboarding logic. ## Signal setup (signal-cli)