docs: add Related sections to remaining CLI, gateway API, and help pages

2026-04-30 22:12:32 +08:00 · 2026-04-23 20:41:26 -07:00
parent 53aac30f51
commit 627c19c5cb
52 changed files with 253 additions and 0 deletions
--- a/docs/cli/acp.md
+++ b/docs/cli/acp.md
@@ -314,3 +314,8 @@ Security note:
 - `--server-args <args...>`: extra arguments passed to the ACP server.
 - `--server-verbose`: enable verbose logging on the ACP server.
 - `--verbose, -v`: verbose client logging.
+
+## Related
+
+- [CLI reference](/cli)
+- [ACP agents](/tools/acp-agents)
--- a/docs/cli/backup.md
+++ b/docs/cli/backup.md
@@ -82,3 +82,7 @@ Practical limits come from the local machine and destination filesystem:
 Large workspaces are usually the main driver of archive size. If you want a smaller or faster backup, use `--no-include-workspace`.

 For the smallest archive, use `--only-config`.
+
+## Related
+
+- [CLI reference](/cli)
--- a/docs/cli/browser.md
+++ b/docs/cli/browser.md
@@ -245,3 +245,8 @@ If the Gateway runs on a different machine than the browser, run a **node host**
 Use `gateway.nodes.browser.mode` to control auto-routing and `gateway.nodes.browser.node` to pin a specific node if multiple are connected.

 Security + remote setup: [Browser tool](/tools/browser), [Remote access](/gateway/remote), [Tailscale](/gateway/tailscale), [Security](/gateway/security)
+
+## Related
+
+- [CLI reference](/cli)
+- [Browser](/tools/browser)
--- a/docs/cli/clawbot.md
+++ b/docs/cli/clawbot.md
@@ -19,3 +19,7 @@ Current supported alias:
 Prefer modern top-level commands directly:

 - `openclaw clawbot qr` -> `openclaw qr`
+
+## Related
+
+- [CLI reference](/cli)
--- a/docs/cli/completion.md
+++ b/docs/cli/completion.md
@@ -33,3 +33,7 @@ openclaw completion --shell bash --write-state
 - `--install` writes a small "OpenClaw Completion" block into your shell profile and points it at the cached script.
 - Without `--install` or `--write-state`, the command prints the script to stdout.
 - Completion generation eagerly loads command trees so nested subcommands are included.
+
+## Related
+
+- [CLI reference](/cli)
--- a/docs/cli/configure.md
+++ b/docs/cli/configure.md
@@ -70,3 +70,8 @@ openclaw configure --section web
 openclaw configure --section model --section channels
 openclaw configure --section gateway --section daemon
 ```
+
+## Related
+
+- [CLI reference](/cli)
+- [Configuration](/gateway/configuration)
--- a/docs/cli/cron.md
+++ b/docs/cli/cron.md
@@ -174,3 +174,8 @@ Failure-delivery note:
  delivery mode is `webhook`.
 - If you do not set any failure destination and the job already announces to a
  channel, failure notifications reuse that same announce target.
+
+## Related
+
+- [CLI reference](/cli)
+- [Scheduled tasks](/automation/cron-jobs)
--- a/docs/cli/daemon.md
+++ b/docs/cli/daemon.md
@@ -55,3 +55,8 @@ Notes:
 ## Prefer

 Use [`openclaw gateway`](/cli/gateway) for current docs and examples.
+
+## Related
+
+- [CLI reference](/cli)
+- [Gateway runbook](/gateway)
--- a/docs/cli/dashboard.md
+++ b/docs/cli/dashboard.md
@@ -20,3 +20,8 @@ Notes:
 - `dashboard` resolves configured `gateway.auth.token` SecretRefs when possible.
 - For SecretRef-managed tokens (resolved or unresolved), `dashboard` prints/copies/opens a non-tokenized URL to avoid exposing external secrets in terminal output, clipboard history, or browser-launch arguments.
 - If `gateway.auth.token` is SecretRef-managed but unresolved in this command path, the command prints a non-tokenized URL and explicit remediation guidance instead of embedding an invalid token placeholder.
+
+## Related
+
+- [CLI reference](/cli)
+- [Dashboard](/web/dashboard)
--- a/docs/cli/devices.md
+++ b/docs/cli/devices.md
@@ -178,3 +178,8 @@ Related:

 - [Dashboard auth troubleshooting](/web/dashboard#if-you-see-unauthorized-1008)
 - [Gateway troubleshooting](/gateway/troubleshooting#dashboard-control-ui-connectivity)
+
+## Related
+
+- [CLI reference](/cli)
+- [Nodes](/nodes)
--- a/docs/cli/directory.md
+++ b/docs/cli/directory.md
@@ -61,3 +61,7 @@ openclaw directory groups list --channel zalouser
 openclaw directory groups list --channel zalouser --query "work"
 openclaw directory groups members --channel zalouser --group-id <id>
 ```
+
+## Related
+
+- [CLI reference](/cli)
--- a/docs/cli/dns.md
+++ b/docs/cli/dns.md
@@ -46,3 +46,8 @@ Notes:
 - If `--domain` is omitted, OpenClaw uses `discovery.wideArea.domain` from config.
 - `--apply` currently supports macOS only and expects Homebrew CoreDNS.
 - `--apply` bootstraps the zone file if needed, ensures the CoreDNS import stanza exists, and restarts the `coredns` brew service.
+
+## Related
+
+- [CLI reference](/cli)
+- [Discovery](/gateway/discovery)
--- a/docs/cli/docs.md
+++ b/docs/cli/docs.md
@@ -26,3 +26,7 @@ Notes:

 - With no query, `openclaw docs` opens the live docs search entrypoint.
 - Multi-word queries are passed through as one search request.
+
+## Related
+
+- [CLI reference](/cli)
--- a/docs/cli/doctor.md
+++ b/docs/cli/doctor.md
@@ -63,3 +63,8 @@ launchctl getenv OPENCLAW_GATEWAY_PASSWORD
 launchctl unsetenv OPENCLAW_GATEWAY_TOKEN
 launchctl unsetenv OPENCLAW_GATEWAY_PASSWORD
 ```
+
+## Related
+
+- [CLI reference](/cli)
+- [Gateway doctor](/gateway/doctor)
--- a/docs/cli/flows.md
+++ b/docs/cli/flows.md
@@ -16,3 +16,8 @@ openclaw tasks flow cancel <lookup>
 ```

 For full documentation see [Task Flow](/automation/taskflow) and the [tasks CLI reference](/cli/tasks).
+
+## Related
+
+- [CLI reference](/cli)
+- [Automation](/automation)
--- a/docs/cli/gateway.md
+++ b/docs/cli/gateway.md
@@ -371,3 +371,8 @@ Notes:
 - On `local.` mDNS, `sshPort` and `cliPath` are only broadcast when
  `discovery.mdns.mode` is `full`. Wide-area DNS-SD still writes `cliPath`; `sshPort`
  stays optional there too.
+
+## Related
+
+- [CLI reference](/cli)
+- [Gateway runbook](/gateway)
--- a/docs/cli/health.md
+++ b/docs/cli/health.md
@@ -34,3 +34,8 @@ Notes:
 - `--verbose` forces a live probe, prints gateway connection details, and expands the
  human-readable output across all configured accounts and agents.
 - Output includes per-agent session stores when multiple agents are configured.
+
+## Related
+
+- [CLI reference](/cli)
+- [Gateway health](/gateway/health)
--- a/docs/cli/logs.md
+++ b/docs/cli/logs.md
@@ -57,3 +57,8 @@ openclaw logs --url ws://127.0.0.1:18789 --token "$OPENCLAW_GATEWAY_TOKEN"

 - Use `--local-time` to render timestamps in your local timezone.
 - If the local loopback Gateway asks for pairing, `openclaw logs` falls back to the configured local log file automatically. Explicit `--url` targets do not use this fallback.
+
+## Related
+
+- [CLI reference](/cli)
+- [Gateway logging](/gateway/logging)
--- a/docs/cli/memory.md
+++ b/docs/cli/memory.md
@@ -174,3 +174,8 @@ Notes:
 - `memory rem-backfill --path <file-or-dir> --stage-short-term` also seeds grounded durable candidates into the live short-term promotion store so the normal deep phase can rank them.
 - `memory rem-backfill --rollback` removes previously written grounded diary entries, and `memory rem-backfill --rollback-short-term` removes previously staged grounded short-term candidates.
 - See [Dreaming](/concepts/dreaming) for full phase descriptions and configuration reference.
+
+## Related
+
+- [CLI reference](/cli)
+- [Memory overview](/concepts/memory)
--- a/docs/cli/message.md
+++ b/docs/cli/message.md
@@ -296,3 +296,8 @@ Send a Telegram image as a document to avoid compression:
 openclaw message send --channel telegram --target @mychat \
  --media ./diagram.png --force-document
 ```
+
+## Related
+
+- [CLI reference](/cli)
+- [Agent send](/tools/agent-send)
--- a/docs/cli/node.md
+++ b/docs/cli/node.md
@@ -135,3 +135,8 @@ For approved async node exec, OpenClaw prepares a canonical `systemRunPlan`
 before prompting. The later approved `system.run` forward reuses that stored
 plan, so edits to command/cwd/session fields after the approval request was
 created are rejected instead of changing what the node executes.
+
+## Related
+
+- [CLI reference](/cli)
+- [Nodes](/nodes)
--- a/docs/cli/proxy.md
+++ b/docs/cli/proxy.md
@@ -43,3 +43,8 @@ openclaw proxy purge
 - `start` defaults to `127.0.0.1` unless `--host` is set.
 - `run` starts a local debug proxy and then runs the command after `--`.
 - Captures are local debugging data; use `openclaw proxy purge` when finished.
+
+## Related
+
+- [CLI reference](/cli)
+- [Trusted proxy auth](/gateway/trusted-proxy-auth)
--- a/docs/cli/qr.md
+++ b/docs/cli/qr.md
@@ -50,3 +50,8 @@ openclaw qr --url wss://gateway.example/ws
 - After scanning, approve device pairing with:
  - `openclaw devices list`
  - `openclaw devices approve <requestId>`
+
+## Related
+
+- [CLI reference](/cli)
+- [Pairing](/cli/pairing)
--- a/docs/cli/reset.md
+++ b/docs/cli/reset.md
@@ -33,3 +33,7 @@ Notes:
 - Run `openclaw backup create` first if you want a restorable snapshot before removing local state.
 - If you omit `--scope`, `openclaw reset` uses an interactive prompt to choose what to remove.
 - `--non-interactive` is only valid when both `--scope` and `--yes` are set.
+
+## Related
+
+- [CLI reference](/cli)
--- a/docs/cli/secrets.md
+++ b/docs/cli/secrets.md
@@ -195,3 +195,8 @@ openclaw secrets audit --check
 ```

 If `audit --check` still reports plaintext findings, update the remaining reported target paths and rerun audit.
+
+## Related
+
+- [CLI reference](/cli)
+- [Secrets management](/gateway/secrets)
--- a/docs/cli/security.md
+++ b/docs/cli/security.md
@@ -84,3 +84,8 @@ openclaw security audit --fix --json | jq '{fix: .fix.ok, summary: .report.summa
 - disable tools (`gateway`, `cron`, `exec`, etc.)
 - change gateway bind/auth/network exposure choices
 - remove or rewrite plugins/skills
+
+## Related
+
+- [CLI reference](/cli)
+- [Security audit](/gateway/security)
--- a/docs/cli/setup.md
+++ b/docs/cli/setup.md
@@ -43,3 +43,8 @@ Notes:

 - Plain `openclaw setup` initializes config + workspace without the full onboarding flow.
 - Onboarding auto-runs when any onboarding flags are present (`--wizard`, `--non-interactive`, `--mode`, `--remote-url`, `--remote-token`).
+
+## Related
+
+- [CLI reference](/cli)
+- [Install overview](/install)
--- a/docs/cli/system.md
+++ b/docs/cli/system.md
@@ -69,3 +69,7 @@ Flags:

 - Requires a running Gateway reachable by your current config (local or remote).
 - System events are ephemeral and not persisted across restarts.
+
+## Related
+
+- [CLI reference](/cli)
--- a/docs/cli/tasks.md
+++ b/docs/cli/tasks.md
@@ -94,3 +94,8 @@ openclaw tasks flow cancel <lookup>
 ```

 Inspects or cancels durable Task Flow state under the task ledger.
+
+## Related
+
+- [CLI reference](/cli)
+- [Background tasks](/automation/tasks)
--- a/docs/cli/tui.md
+++ b/docs/cli/tui.md
@@ -65,3 +65,8 @@ Then inside the TUI:

 Apply targeted fixes with `openclaw config set` or `openclaw configure`, then
 rerun `openclaw config validate`. See [TUI](/web/tui) and [Config](/cli/config).
+
+## Related
+
+- [CLI reference](/cli)
+- [TUI](/web/tui)
--- a/docs/cli/uninstall.md
+++ b/docs/cli/uninstall.md
@@ -37,3 +37,8 @@ Notes:
 - Run `openclaw backup create` first if you want a restorable snapshot before removing state or workspaces.
 - `--all` is shorthand for removing service, state, workspace, and app together.
 - `--non-interactive` requires `--yes`.
+
+## Related
+
+- [CLI reference](/cli)
+- [Uninstall](/install/uninstall)
--- a/docs/cli/voicecall.md
+++ b/docs/cli/voicecall.md
@@ -33,3 +33,8 @@ openclaw voicecall expose --mode off
 ```

 Security note: only expose the webhook endpoint to networks you trust. Prefer Tailscale Serve over Funnel when possible.
+
+## Related
+
+- [CLI reference](/cli)
+- [Voice call plugin](/plugins/voice-call)
--- a/docs/cli/webhooks.md
+++ b/docs/cli/webhooks.md
@@ -89,3 +89,8 @@ openclaw webhooks gmail run --account you@example.com
 ```

 See [Gmail Pub/Sub documentation](/automation/cron-jobs#gmail-pubsub-integration) for the end-to-end setup flow and operational details.
+
+## Related
+
+- [CLI reference](/cli)
+- [Webhook automation](/automation/webhook)
--- a/docs/cli/wiki.md
+++ b/docs/cli/wiki.md
@@ -212,3 +212,8 @@ These require the official `obsidian` CLI on `PATH` when
 - `plugins.entries.memory-wiki.config.context.includeCompiledDigestPrompt`

 See [Memory Wiki plugin](/plugins/memory-wiki) for the full config model.
+
+## Related
+
+- [CLI reference](/cli)
+- [Memory wiki](/plugins/memory-wiki)
--- a/docs/gateway/background-process.md
+++ b/docs/gateway/background-process.md
@@ -129,3 +129,8 @@ Paste literal text:
 ```json
 { "tool": "process", "action": "paste", "sessionId": "<id>", "text": "line1\nline2\n" }
 ```
+
+## Related
+
+- [Exec tool](/tools/exec)
+- [Exec approvals](/tools/exec-approvals)
--- a/docs/gateway/bridge-protocol.md
+++ b/docs/gateway/bridge-protocol.md
@@ -87,3 +87,8 @@ Payload fields (all optional unless noted):
 The bridge was **implicit v1** (no min/max negotiation). This section is
 historical reference only; current node/operator clients use the WebSocket
 [Gateway Protocol](/gateway/protocol).
+
+## Related
+
+- [Gateway protocol](/gateway/protocol)
+- [Nodes](/nodes)
--- a/docs/gateway/cli-backends.md
+++ b/docs/gateway/cli-backends.md
@@ -370,3 +370,8 @@ backend opts into bundle MCP so background runs stay isolated.
 - **No session continuity**: ensure `sessionArg` is set and `sessionMode` is not
  `none` (Codex CLI currently cannot resume with JSON output).
 - **Images ignored**: set `imageArg` (and verify CLI supports file paths).
+
+## Related
+
+- [Gateway runbook](/gateway)
+- [Local models](/gateway/local-models)
--- a/docs/gateway/logging.md
+++ b/docs/gateway/logging.md
@@ -111,3 +111,8 @@ Behavior:
 - **WhatsApp message bodies** are logged at `debug` (use `--verbose` to see them)

 This keeps existing file logs stable while making interactive output scannable.
+
+## Related
+
+- [Logging overview](/logging)
+- [Diagnostics export](/gateway/diagnostics)
--- a/docs/gateway/openai-http-api.md
+++ b/docs/gateway/openai-http-api.md
@@ -278,3 +278,8 @@ Notes:
 - `openclaw/default` is always present so one stable id works across environments.
 - Backend provider/model overrides belong in `x-openclaw-model`, not the OpenAI `model` field.
 - `/v1/embeddings` supports `input` as a string or array of strings.
+
+## Related
+
+- [Configuration reference](/gateway/configuration-reference)
+- [OpenAI](/providers/openai)
--- a/docs/gateway/openresponses-http-api.md
+++ b/docs/gateway/openresponses-http-api.md
@@ -338,3 +338,8 @@ curl -N http://127.0.0.1:18789/v1/responses \
    "input": "hi"
  }'
 ```
+
+## Related
+
+- [OpenAI chat completions](/gateway/openai-http-api)
+- [OpenAI](/providers/openai)
--- a/docs/gateway/remote-gateway-readme.md
+++ b/docs/gateway/remote-gateway-readme.md
@@ -162,3 +162,8 @@ launchctl bootout gui/$UID/ai.openclaw.ssh-tunnel
 | `RunAtLoad`                          | Starts tunnel when the agent loads                           |

 OpenClaw.app connects to `ws://127.0.0.1:18789` on your client machine. The SSH tunnel forwards that connection to port 18789 on the remote machine where the Gateway is running.
+
+## Related
+
+- [Remote access](/gateway/remote)
+- [Tailscale](/gateway/tailscale)
--- a/docs/gateway/tools-invoke-http-api.md
+++ b/docs/gateway/tools-invoke-http-api.md
@@ -159,3 +159,8 @@ curl -sS http://127.0.0.1:18789/tools/invoke \
    "args": {}
  }'
 ```
+
+## Related
+
+- [Gateway protocol](/gateway/protocol)
+- [Tools and plugins](/tools)
--- a/docs/help/debugging.md
+++ b/docs/help/debugging.md
@@ -321,3 +321,8 @@ Default file:
 - Raw stream logs can include full prompts, tool output, and user data.
 - Keep logs local and delete them after debugging.
 - If you share logs, scrub secrets and PII first.
+
+## Related
+
+- [Troubleshooting](/help/troubleshooting)
+- [FAQ](/help/faq)
--- a/docs/help/faq.md
+++ b/docs/help/faq.md
@@ -1967,3 +1967,9 @@ moved to a dedicated page:
 ---

 Still stuck? Ask in [Discord](https://discord.com/invite/clawd) or open a [GitHub discussion](https://github.com/openclaw/openclaw/discussions).
+
+## Related
+
+- [FAQ — quick start and first-run setup](/help/faq-first-run)
+- [FAQ — models and auth profiles](/help/faq-models)
+- [Troubleshooting](/help/troubleshooting)
--- a/docs/help/gpt54-codex-agentic-parity-maintainers.md
+++ b/docs/help/gpt54-codex-agentic-parity-maintainers.md
@@ -168,3 +168,7 @@ The parity harness is not the only evidence source. Keep this split explicit in
 | `/elevated full` hints were sometimes misleading            | PR B ties guidance to actual runtime capability and blocked reasons                     |
 | Long tasks could disappear into replay/compaction ambiguity | PR C emits explicit paused, blocked, abandoned, and replay-invalid state                |
 | Parity claims were anecdotal                                | PR D produces a report plus JSON verdict with the same scenario coverage on both models |
+
+## Related
+
+- [GPT-5.4 / Codex agentic parity](/help/gpt54-codex-agentic-parity)
--- a/docs/help/gpt54-codex-agentic-parity.md
+++ b/docs/help/gpt54-codex-agentic-parity.md
@@ -226,3 +226,7 @@ Keep the default contract when:
 - you want the existing looser behavior
 - you are not using GPT-5-family models
 - you are testing prompts rather than runtime enforcement
+
+## Related
+
+- [GPT-5.4 / Codex parity maintainer notes](/help/gpt54-codex-agentic-parity-maintainers)
--- a/docs/help/scripts.md
+++ b/docs/help/scripts.md
@@ -49,3 +49,8 @@ Examples:

 - Keep scripts focused and documented.
 - Add a short entry in the relevant doc (or create one if missing).
+
+## Related
+
+- [Testing](/help/testing)
+- [Testing live](/help/testing-live)
--- a/docs/help/testing.md
+++ b/docs/help/testing.md
@@ -699,3 +699,8 @@ When you fix a provider/model issue discovered in live:
 - SecretRef traversal guardrail:
  - `src/secrets/exec-secret-ref-id-parity.test.ts` derives one sampled target per SecretRef class from registry metadata (`listSecretTargetRegistryEntries()`), then asserts traversal-segment exec ids are rejected.
  - If you add a new `includeInPlan` SecretRef target family in `src/secrets/target-registry-data.ts`, update `classifyTargetClass` in that test. The test intentionally fails on unclassified target ids so new classes cannot be skipped silently.
+
+## Related
+
+- [Testing live](/help/testing-live)
+- [CI](/ci)
--- a/docs/refactor/qa.md
+++ b/docs/refactor/qa.md
@@ -534,3 +534,8 @@ This is the smallest path that proves both goals:
 - whether artifact references should be strongly typed in schema or string-based
 - whether custom handlers should live in one registry or per-surface registries
 - whether the generated JSON compatibility file should remain checked in during migration
+
+## Related
+
+- [QA E2E automation](/concepts/qa-e2e-automation)
+- [QA refactor](/refactor/qa-refactor)
--- a/docs/start/docs-directory.md
+++ b/docs/start/docs-directory.md
@@ -63,3 +63,8 @@ For a complete map of the docs, see [Docs hubs](/start/hubs).
 - [Gmail hooks (Pub/Sub)](/automation/cron-jobs#gmail-pubsub-integration)
 - [Security](/gateway/security)
 - [Troubleshooting](/gateway/troubleshooting)
+
+## Related
+
+- [Getting started](/start/getting-started)
+- [Docs hubs](/start/hubs)
--- a/docs/start/getting-started.md
+++ b/docs/start/getting-started.md
@@ -144,3 +144,9 @@ openclaw dashboard

 Full reference: [Environment variables](/help/environment).
 </Accordion>
+
+## Related
+
+- [Install overview](/install)
+- [Channels overview](/channels)
+- [Setup](/start/setup)
--- a/docs/start/onboarding.md
+++ b/docs/start/onboarding.md
@@ -88,3 +88,8 @@ Onboarding requests TCC permissions needed for:
  what happens on the gateway host during the first agent run.
 </Step>
 </Steps>
+
+## Related
+
+- [Onboarding overview](/start/onboarding-overview)
+- [Getting started](/start/getting-started)