From e85fd2abcda67ecf5f2a14afd663a7c1ebc680b8 Mon Sep 17 00:00:00 2001 From: Vincent Koc Date: Tue, 5 May 2026 22:34:25 -0700 Subject: [PATCH] docs: typography hygiene + dup H1 across 5 pages (cli/gateway/help) --- docs/cli/acp.md | 6 +++--- docs/cli/status.md | 10 ++++------ docs/gateway/background-process.md | 8 +++----- docs/gateway/cli-backends.md | 6 +++--- docs/help/debugging.md | 6 +++--- 5 files changed, 16 insertions(+), 20 deletions(-) diff --git a/docs/cli/acp.md b/docs/cli/acp.md index 5d855c44e7b..cf04020a938 100644 --- a/docs/cli/acp.md +++ b/docs/cli/acp.md @@ -118,7 +118,7 @@ Permission model (client debug mode): - `read` auto-approval is scoped to the current working directory (`--cwd` when set). - ACP only auto-approves narrow readonly classes: scoped `read` calls under the active cwd plus readonly search tools (`search`, `web_search`, `memory_search`). Unknown/non-core tools, out-of-scope reads, exec-capable tools, control-plane tools, mutating tools, and interactive flows always require explicit prompt approval. - Server-provided `toolCall.kind` is treated as untrusted metadata (not an authorization source). -- This ACP bridge policy is separate from ACPX harness permissions. If you run OpenClaw through the `acpx` backend, `plugins.entries.acpx.config.permissionMode=approve-all` is the break-glass “yolo” switch for that harness session. +- This ACP bridge policy is separate from ACPX harness permissions. If you run OpenClaw through the `acpx` backend, `plugins.entries.acpx.config.permissionMode=approve-all` is the break-glass "yolo" switch for that harness session. ## How to use this @@ -218,7 +218,7 @@ pull contextual information from an OpenClaw agent without scraping a terminal. ## Zed editor setup -Add a custom ACP agent in `~/.config/zed/settings.json` (or use Zed’s Settings UI): +Add a custom ACP agent in `~/.config/zed/settings.json` (or use Zed's Settings UI): ```json { @@ -256,7 +256,7 @@ To target a specific Gateway or agent: } ``` -In Zed, open the Agent panel and select “OpenClaw ACP” to start a thread. +In Zed, open the Agent panel and select "OpenClaw ACP" to start a thread. ## Session mapping diff --git a/docs/cli/status.md b/docs/cli/status.md index 8577e869ec5..0efe4e47eb7 100644 --- a/docs/cli/status.md +++ b/docs/cli/status.md @@ -2,12 +2,10 @@ summary: "CLI reference for `openclaw status` (diagnostics, probes, usage snapshots)" read_when: - You want a quick diagnosis of channel health + recent session recipients - - You want a pasteable “all” status for debugging -title: "Status" + - You want a pasteable "all" status for debugging +title: "openclaw status" --- -# `openclaw status` - Diagnostics for channels + sessions. ```bash @@ -34,8 +32,8 @@ Notes: - Overview includes update channel + git SHA (for source checkouts). - Update info surfaces in the Overview; if an update is available, status prints a hint to run `openclaw update` (see [Updating](/install/updating)). - Read-only status surfaces (`status`, `status --json`, `status --all`) resolve supported SecretRefs for their targeted config paths when possible. -- If a supported channel SecretRef is configured but unavailable in the current command path, status stays read-only and reports degraded output instead of crashing. Human output shows warnings such as “configured token unavailable in this command path”, and JSON output includes `secretDiagnostics`. -- When command-local SecretRef resolution succeeds, status prefers the resolved snapshot and clears transient “secret unavailable” channel markers from the final output. +- If a supported channel SecretRef is configured but unavailable in the current command path, status stays read-only and reports degraded output instead of crashing. Human output shows warnings such as "configured token unavailable in this command path", and JSON output includes `secretDiagnostics`. +- When command-local SecretRef resolution succeeds, status prefers the resolved snapshot and clears transient "secret unavailable" channel markers from the final output. - `status --all` includes a Secrets overview row and a diagnosis section that summarizes secret diagnostics (truncated for readability) without stopping report generation. ## Related diff --git a/docs/gateway/background-process.md b/docs/gateway/background-process.md index 03a0811d077..1857cf6548a 100644 --- a/docs/gateway/background-process.md +++ b/docs/gateway/background-process.md @@ -6,16 +6,14 @@ read_when: title: "Background exec and process tool" --- -# Background Exec + Process Tool - -OpenClaw runs shell commands through the `exec` tool and keeps long‑running tasks in memory. The `process` tool manages those background sessions. +OpenClaw runs shell commands through the `exec` tool and keeps long-running tasks in memory. The `process` tool manages those background sessions. ## exec tool Key parameters: - `command` (required) -- `yieldMs` (default 10000): auto‑background after this delay +- `yieldMs` (default 10000): auto-background after this delay - `background` (bool): background immediately - `timeout` (seconds, default `tools.exec.timeoutSec`): kill the process after this timeout; set `timeout: 0` only to disable the exec process timeout for that call - `elevated` (bool): run outside the sandbox if elevated mode is enabled/allowed (`gateway` by default, or `node` when the exec target is `node`) @@ -45,7 +43,7 @@ When spawning long-running child processes outside the exec/process tools (for e Environment overrides: - `PI_BASH_YIELD_MS`: default yield (ms) -- `PI_BASH_MAX_OUTPUT_CHARS`: in‑memory output cap (chars) +- `PI_BASH_MAX_OUTPUT_CHARS`: in-memory output cap (chars) - `OPENCLAW_BASH_PENDING_MAX_OUTPUT_CHARS`: pending stdout/stderr cap per stream (chars) - `PI_BASH_JOB_TTL_MS`: TTL for finished sessions (ms, bounded to 1m–3h) diff --git a/docs/gateway/cli-backends.md b/docs/gateway/cli-backends.md index 6cb5cb47b07..c754064b33f 100644 --- a/docs/gateway/cli-backends.md +++ b/docs/gateway/cli-backends.md @@ -17,7 +17,7 @@ rate-limited, or temporarily misbehaving. This is intentionally conservative: - **Images can be passed through** if the CLI accepts image paths. This is designed as a **safety net** rather than a primary path. Use it when you -want “always works” text responses without relying on external APIs. +want "always works" text responses without relying on external APIs. If you want a full harness runtime with ACP session controls, background tasks, thread/conversation binding, and persistent external coding sessions, use @@ -49,7 +49,7 @@ command path: } ``` -That’s it. No keys, no extra auth config needed beyond the CLI itself. +That's it. No keys, no extra auth config needed beyond the CLI itself. If you use a bundled CLI backend as the **primary message provider** on a gateway host, OpenClaw now auto-loads the owning bundled plugin when your config @@ -397,7 +397,7 @@ children and Streamable HTTP/SSE streams do not outlive the run. `bundleMcp: true`. - **Streaming is backend-specific.** Some backends stream JSONL; others buffer until exit. -- **Structured outputs** depend on the CLI’s JSON format. +- **Structured outputs** depend on the CLI's JSON format. - **Codex CLI sessions** resume via text output (no JSONL), which is less structured than the initial `--json` run. OpenClaw sessions still work normally. diff --git a/docs/help/debugging.md b/docs/help/debugging.md index 661014cbba7..eeafe463894 100644 --- a/docs/help/debugging.md +++ b/docs/help/debugging.md @@ -203,7 +203,7 @@ pnpm gateway:dev OPENCLAW_PROFILE=dev openclaw tui ``` -If you don’t have a global install yet, run the CLI via `pnpm openclaw ...`. +If you don't have a global install yet, run the CLI via `pnpm openclaw ...`. What this does: @@ -219,7 +219,7 @@ What this does: - Sets `agent.skipBootstrap=true` (no BOOTSTRAP.md). - Seeds the workspace files if missing: `AGENTS.md`, `SOUL.md`, `TOOLS.md`, `IDENTITY.md`, `USER.md`, `HEARTBEAT.md`. - - Default identity: **C3‑PO** (protocol droid). + - Default identity: **C3-PO** (protocol droid). - Skips channel providers in dev mode (`OPENCLAW_SKIP_CHANNELS=1`). Reset flow (fresh start): @@ -297,7 +297,7 @@ Default file: `~/.pi-mono/logs/raw-openai-completions.jsonl` -> Note: this is only emitted by processes using pi-mono’s +> Note: this is only emitted by processes using pi-mono's > `openai-completions` provider. ## Safety notes