From 05ebfa4146c63ddff7b87aca47406c0f2a343f8c Mon Sep 17 00:00:00 2001 From: Vincent Koc Date: Sun, 26 Apr 2026 22:01:40 -0700 Subject: [PATCH] docs(help+tools): batch convert prose callouts to Mintlify components - testing-live: Tip components for model-discovery and authoritative-list guidance - debugging: --dev flag Note and non-dev gateway stop Tip - testing: narrowing live tests Tip - tools/lobster: optional-plugin allowlist Note - tools/acp-agents-setup: blockquote Important to Warning component --- docs/help/debugging.md | 9 ++++++--- docs/help/testing-live.md | 8 ++++++-- docs/help/testing.md | 4 +++- docs/tools/acp-agents-setup.md | 8 +++++--- docs/tools/lobster.md | 6 +++--- 5 files changed, 23 insertions(+), 12 deletions(-) diff --git a/docs/help/debugging.md b/docs/help/debugging.md index 85f75c8e8be..cd56d36b6a9 100644 --- a/docs/help/debugging.md +++ b/docs/help/debugging.md @@ -249,21 +249,24 @@ Reset flow (fresh start): pnpm gateway:dev:reset ``` -Note: `--dev` is a **global** profile flag and gets eaten by some runners. -If you need to spell it out, use the env var form: + +`--dev` is a **global** profile flag and gets eaten by some runners. If you need to spell it out, use the env var form: ```bash OPENCLAW_PROFILE=dev openclaw gateway --dev --reset ``` + `--reset` wipes config, credentials, sessions, and the dev workspace (using `trash`, not `rm`), then recreates the default dev setup. -Tip: if a non‑dev gateway is already running (launchd/systemd), stop it first: + +If a non-dev gateway is already running (launchd or systemd), stop it first: ```bash openclaw gateway stop ``` + ## Raw stream logging (OpenClaw) diff --git a/docs/help/testing-live.md b/docs/help/testing-live.md index 9323873113d..8507deef646 100644 --- a/docs/help/testing-live.md +++ b/docs/help/testing-live.md @@ -127,12 +127,14 @@ Live tests are split into two layers so we can isolate failures: - Embedded agent forwards a multimodal user message to the model - Assertion: reply contains `cat` + the code (OCR tolerance: minor mistakes allowed) -Tip: to see what you can test on your machine (and the exact `provider/model` ids), run: + +To see what you can test on your machine (and the exact `provider/model` ids), run: ```bash openclaw models list openclaw models list --json ``` + ## Live: CLI backend smoke (Claude, Codex, Gemini, or other local CLIs) @@ -413,7 +415,9 @@ More providers you can include in the live matrix (if you have creds/config): - Built-in: `openai`, `openai-codex`, `anthropic`, `google`, `google-vertex`, `google-antigravity`, `google-gemini-cli`, `zai`, `openrouter`, `opencode`, `opencode-go`, `xai`, `groq`, `cerebras`, `mistral`, `github-copilot` - Via `models.providers` (custom endpoints): `minimax` (cloud/API), plus any OpenAI/Anthropic-compatible proxy (LM Studio, vLLM, LiteLLM, etc.) -Tip: don’t try to hardcode “all models” in docs. The authoritative list is whatever `discoverModels(...)` returns on your machine + whatever keys are available. + +Do not hardcode "all models" in docs. The authoritative list is whatever `discoverModels(...)` returns on your machine plus whatever keys are available. + ## Credentials (never commit) diff --git a/docs/help/testing.md b/docs/help/testing.md index 52bd52c639b..5110034dd5e 100644 --- a/docs/help/testing.md +++ b/docs/help/testing.md @@ -84,7 +84,9 @@ When debugging real providers/models (requires real creds): against `moonshot/kimi-k2.6`. Verify the JSON reports Moonshot/K2.6 and the assistant transcript stores normalized `usage.cost`. -Tip: when you only need one failing case, prefer narrowing live tests via the allowlist env vars described below. + +When you only need one failing case, prefer narrowing live tests via the allowlist env vars described below. + ## QA-specific runners diff --git a/docs/tools/acp-agents-setup.md b/docs/tools/acp-agents-setup.md index 0234c20fede..44787262c0f 100644 --- a/docs/tools/acp-agents-setup.md +++ b/docs/tools/acp-agents-setup.md @@ -304,9 +304,11 @@ openclaw config set plugins.entries.acpx.config.nonInteractivePermissions fail Restart the gateway after changing these values. -> **Important:** OpenClaw currently defaults to `permissionMode=approve-reads` and `nonInteractivePermissions=fail`. In non-interactive ACP sessions, any write or exec that triggers a permission prompt can fail with `AcpRuntimeError: Permission prompt unavailable in non-interactive mode`. -> -> If you need to restrict permissions, set `nonInteractivePermissions` to `deny` so sessions degrade gracefully instead of crashing. + +OpenClaw defaults to `permissionMode=approve-reads` and `nonInteractivePermissions=fail`. In non-interactive ACP sessions, any write or exec that triggers a permission prompt can fail with `AcpRuntimeError: Permission prompt unavailable in non-interactive mode`. + +If you need to restrict permissions, set `nonInteractivePermissions` to `deny` so sessions degrade gracefully instead of crashing. + ## Related diff --git a/docs/tools/lobster.md b/docs/tools/lobster.md index ba9487d5d05..0b94c2cd4fd 100644 --- a/docs/tools/lobster.md +++ b/docs/tools/lobster.md @@ -190,9 +190,9 @@ Or per-agent: Avoid using `tools.allow: ["lobster"]` unless you intend to run in restrictive allowlist mode. -Note: allowlists are opt-in for optional plugins. If your allowlist only names -plugin tools (like `lobster`), OpenClaw keeps core tools enabled. To restrict core -tools, include the core tools or groups you want in the allowlist too. + +Allowlists are opt-in for optional plugins. If your allowlist only names plugin tools (like `lobster`), OpenClaw keeps core tools enabled. To restrict core tools, include the core tools or groups you want in the allowlist too. + ## Example: Email triage