docs(gateway,platforms,cli): add Related sections to entry and reference pages

2026-05-06 15:18:58 +00:00 · 2026-04-23 20:08:26 -07:00
parent f0b6c65e3b
commit 8d1f98ef08
36 changed files with 198 additions and 0 deletions
--- a/docs/cli/agent.md
+++ b/docs/cli/agent.md
@@ -55,3 +55,8 @@ openclaw agent --agent ops --message "Run locally" --local
 - `--channel`, `--reply-channel`, and `--reply-account` affect reply delivery, not session routing.
 - When this command triggers `models.json` regeneration, SecretRef-managed provider credentials are persisted as non-secret markers (for example env var names, `secretref-env:ENV_VAR_NAME`, or `secretref-managed`), not resolved secret plaintext.
 - Marker writes are source-authoritative: OpenClaw persists markers from the active source config snapshot, not from resolved runtime secret values.
+
+## Related
+
+- [CLI reference](/cli)
+- [Agent runtime](/concepts/agent)
--- a/docs/cli/agents.md
+++ b/docs/cli/agents.md
@@ -218,3 +218,9 @@ Config sample:
  },
 }
 ```
+
+## Related
+
+- [CLI reference](/cli)
+- [Multi-agent routing](/concepts/multi-agent)
+- [Agent workspace](/concepts/agent-workspace)
--- a/docs/cli/approvals.md
+++ b/docs/cli/approvals.md
@@ -183,3 +183,8 @@ Targeting notes:
 - `--agent` defaults to `"*"`, which applies to all agents.
 - The node host must advertise `system.execApprovals.get/set` (macOS app or headless node host).
 - Approvals files are stored per host at `~/.openclaw/exec-approvals.json`.
+
+## Related
+
+- [CLI reference](/cli)
+- [Exec approvals](/tools/exec-approvals)
--- a/docs/cli/channels.md
+++ b/docs/cli/channels.md
@@ -129,3 +129,8 @@ Notes:
 - Use `--kind user|group|auto` to force the target type.
 - Resolution prefers active matches when multiple entries share the same name.
 - `channels resolve` is read-only. If a selected account is configured via SecretRef but that credential is unavailable in the current command path, the command returns degraded unresolved results with notes instead of aborting the entire run.
+
+## Related
+
+- [CLI reference](/cli)
+- [Channels overview](/channels)
--- a/docs/cli/config.md
+++ b/docs/cli/config.md
@@ -428,3 +428,8 @@ Typical repair loop:
 - Apply targeted edits with `openclaw config set` or `openclaw configure`.
 - Rerun `openclaw config validate` after each change.
 - If validation passes but the runtime is still unhealthy, run `openclaw doctor` or `openclaw doctor --fix` for migration and repair help.
+
+## Related
+
+- [CLI reference](/cli)
+- [Configuration](/gateway/configuration)
--- a/docs/cli/hooks.md
+++ b/docs/cli/hooks.md
@@ -336,3 +336,8 @@ openclaw hooks enable boot-md
 ```

 **See:** [boot-md documentation](/automation/hooks#boot-md)
+
+## Related
+
+- [CLI reference](/cli)
+- [Automation hooks](/automation/hooks)
--- a/docs/cli/infer.md
+++ b/docs/cli/infer.md
@@ -279,3 +279,8 @@ openclaw infer audio transcribe --file ./memo.m4a --model openai/whisper-1 --jso
 ## Notes

 - `openclaw capability ...` is an alias for `openclaw infer ...`.
+
+## Related
+
+- [CLI reference](/cli)
+- [Models](/concepts/models)
--- a/docs/cli/mcp.md
+++ b/docs/cli/mcp.md
@@ -516,3 +516,8 @@ Current limits:
 - HTTP/SSE/streamable-http transport connects to a single remote server; no multiplexed upstream yet
 - `permissions_list_open` only includes approvals observed while the bridge is
  connected
+
+## Related
+
+- [CLI reference](/cli)
+- [Plugins](/cli/plugins)
--- a/docs/cli/models.md
+++ b/docs/cli/models.md
@@ -142,3 +142,9 @@ Notes:
  relative duration such as `365d` or `12h`.
 - Anthropic note: Anthropic staff told us OpenClaw-style Claude CLI usage is allowed again, so OpenClaw treats Claude CLI reuse and `claude -p` usage as sanctioned for this integration unless Anthropic publishes a new policy.
 - Anthropic `setup-token` / `paste-token` remain available as a supported OpenClaw token path, but OpenClaw now prefers Claude CLI reuse and `claude -p` when available.
+
+## Related
+
+- [CLI reference](/cli)
+- [Model selection](/concepts/model-providers)
+- [Model failover](/concepts/model-failover)
--- a/docs/cli/nodes.md
+++ b/docs/cli/nodes.md
@@ -64,3 +64,8 @@ Invoke flags:
 For shell execution on a node, use the `exec` tool with `host=node` instead of `openclaw nodes run`.
 The `nodes` CLI is now capability-focused: direct RPC via `nodes invoke`, plus pairing, camera,
 screen, location, canvas, and notifications.
+
+## Related
+
+- [CLI reference](/cli)
+- [Nodes](/nodes)
--- a/docs/cli/pairing.md
+++ b/docs/cli/pairing.md
@@ -63,3 +63,8 @@ Options:
 - `pairing list` supports `--account <accountId>` for multi-account channels.
 - `pairing approve` supports `--account <accountId>` and `--notify`.
 - If only one pairing-capable channel is configured, `pairing approve <code>` is allowed.
+
+## Related
+
+- [CLI reference](/cli)
+- [Channel pairing](/channels/pairing)
--- a/docs/cli/plugins.md
+++ b/docs/cli/plugins.md
@@ -327,3 +327,9 @@ Marketplace list accepts a local marketplace path, a `marketplace.json` path, a
 GitHub shorthand like `owner/repo`, a GitHub repo URL, or a git URL. `--json`
 prints the resolved source label plus the parsed marketplace manifest and
 plugin entries.
+
+## Related
+
+- [CLI reference](/cli)
+- [Building plugins](/plugins/building-plugins)
+- [Community plugins](/plugins/community)
--- a/docs/cli/sandbox.md
+++ b/docs/cli/sandbox.md
@@ -193,3 +193,8 @@ Sandbox settings live in `~/.openclaw/openclaw.json` under `agents.defaults.sand
 - [Sandbox Documentation](/gateway/sandboxing)
 - [Agent Configuration](/concepts/agent-workspace)
 - [Doctor Command](/gateway/doctor) - Check sandbox setup
+
+## Related
+
+- [CLI reference](/cli)
+- [Sandboxing](/gateway/sandboxing)
--- a/docs/cli/sessions.md
+++ b/docs/cli/sessions.md
@@ -111,3 +111,8 @@ openclaw sessions cleanup --json
 Related:

 - Session config: [Configuration reference](/gateway/configuration-reference#session)
+
+## Related
+
+- [CLI reference](/cli)
+- [Session management](/concepts/session)
--- a/docs/cli/skills.md
+++ b/docs/cli/skills.md
@@ -57,3 +57,8 @@ Notes:
 - `list`, `info`, and `check` write their rendered output to stdout. With
  `--json`, that means the machine-readable payload stays on stdout for pipes
  and scripts.
+
+## Related
+
+- [CLI reference](/cli)
+- [Skills](/tools/skills)
--- a/docs/cli/status.md
+++ b/docs/cli/status.md
@@ -34,3 +34,8 @@ Notes:
 - 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
+
+- [CLI reference](/cli)
+- [Doctor](/gateway/doctor)
--- a/docs/gateway/authentication.md
+++ b/docs/gateway/authentication.md
@@ -202,3 +202,9 @@ openclaw models status
 Run `openclaw models status` to confirm which profile is expiring. If an
 Anthropic token profile is missing or expired, refresh that setup via
 setup-token or migrate to an Anthropic API key.
+
+## Related
+
+- [Secrets management](/gateway/secrets)
+- [Remote access](/gateway/remote)
+- [Auth storage](/concepts/oauth)
--- a/docs/gateway/configuration-examples.md
+++ b/docs/gateway/configuration-examples.md
@@ -627,3 +627,8 @@ Only enable direct mutable name/email/nick matching with each channel's `dangero
 - Provider IDs differ (phone numbers, user IDs, channel IDs). Use the provider docs to confirm the format.
 - Optional sections to add later: `web`, `browser`, `ui`, `discovery`, `canvasHost`, `talk`, `signal`, `imessage`.
 - See [Providers](/providers) and [Troubleshooting](/gateway/troubleshooting) for deeper setup notes.
+
+## Related
+
+- [Configuration reference](/gateway/configuration-reference)
+- [Configuration](/gateway/configuration)
--- a/docs/gateway/configuration-reference.md
+++ b/docs/gateway/configuration-reference.md
@@ -3913,3 +3913,8 @@ Split config into multiple files:
 ---

 _Related: [Configuration](/gateway/configuration) · [Configuration Examples](/gateway/configuration-examples) · [Doctor](/gateway/doctor)_
+
+## Related
+
+- [Configuration](/gateway/configuration)
+- [Configuration examples](/gateway/configuration-examples)
--- a/docs/gateway/configuration.md
+++ b/docs/gateway/configuration.md
@@ -685,3 +685,9 @@ For the complete field-by-field reference, see **[Configuration Reference](/gate
 ---

 _Related: [Configuration Examples](/gateway/configuration-examples) · [Configuration Reference](/gateway/configuration-reference) · [Doctor](/gateway/doctor)_
+
+## Related
+
+- [Configuration reference](/gateway/configuration-reference)
+- [Configuration examples](/gateway/configuration-examples)
+- [Gateway runbook](/gateway)
--- a/docs/gateway/discovery.md
+++ b/docs/gateway/discovery.md
@@ -139,3 +139,9 @@ The gateway is the source of truth for node/client admission.
 - **Gateway**: advertises discovery beacons, owns pairing decisions, and hosts the WS endpoint.
 - **macOS app**: helps you pick a gateway, shows pairing prompts, and uses SSH only as a fallback.
 - **iOS/Android nodes**: browse Bonjour as a convenience and connect to the paired Gateway WS.
+
+## Related
+
+- [Remote access](/gateway/remote)
+- [Tailscale](/gateway/tailscale)
+- [Bonjour discovery](/gateway/bonjour)
--- a/docs/gateway/doctor.md
+++ b/docs/gateway/doctor.md
@@ -573,3 +573,8 @@ if the workspace is not already under git.

 See [/concepts/agent-workspace](/concepts/agent-workspace) for a full guide to
 workspace structure and git backup (recommended private GitHub or GitLab).
+
+## Related
+
+- [Gateway troubleshooting](/gateway/troubleshooting)
+- [Gateway runbook](/gateway)
--- a/docs/gateway/health.md
+++ b/docs/gateway/health.md
@@ -61,3 +61,9 @@ Options:
 - `--debug`: alias for `--verbose`

 The health snapshot includes: `ok` (boolean), `ts` (timestamp), `durationMs` (probe time), per-channel status, agent availability, and session-store summary.
+
+## Related
+
+- [Gateway runbook](/gateway)
+- [Diagnostics export](/gateway/diagnostics)
+- [Gateway troubleshooting](/gateway/troubleshooting)
--- a/docs/gateway/index.md
+++ b/docs/gateway/index.md
@@ -356,3 +356,10 @@ Related:
 - [Health](/gateway/health)
 - [Doctor](/gateway/doctor)
 - [Authentication](/gateway/authentication)
+
+## Related
+
+- [Configuration](/gateway/configuration)
+- [Gateway troubleshooting](/gateway/troubleshooting)
+- [Remote access](/gateway/remote)
+- [Secrets management](/gateway/secrets)
--- a/docs/gateway/local-models.md
+++ b/docs/gateway/local-models.md
@@ -185,3 +185,8 @@ Compatibility notes for stricter OpenAI-compatible backends:
  `compat.supportsTools: false`, then retest. If the server still crashes only
  on larger OpenClaw prompts, treat it as an upstream server/model limitation.
 - Safety: local models skip provider-side filters; keep agents narrow and compaction on to limit prompt injection blast radius.
+
+## Related
+
+- [Configuration reference](/gateway/configuration-reference)
+- [Model failover](/concepts/model-failover)
--- a/docs/gateway/multiple-gateways.md
+++ b/docs/gateway/multiple-gateways.md
@@ -172,3 +172,9 @@ Interpretation:

 - `gateway status --deep` helps catch stale launchd/systemd/schtasks services from older installs.
 - `gateway probe` warning text such as `multiple reachable gateways detected` is expected only when you intentionally run more than one isolated gateway.
+
+## Related
+
+- [Gateway runbook](/gateway)
+- [Gateway lock](/gateway/gateway-lock)
+- [Configuration](/gateway/configuration)
--- a/docs/gateway/network-model.md
+++ b/docs/gateway/network-model.md
@@ -21,3 +21,9 @@ process that owns channel connections and the WebSocket control plane.
  - `/__openclaw__/a2ui/`
    When `gateway.auth` is configured and the Gateway binds beyond loopback, these routes are protected by Gateway auth. Node clients use node-scoped capability URLs tied to their active WS session. See [Gateway configuration](/gateway/configuration) (`canvasHost`, `gateway`).
 - Remote use is typically SSH tunnel or tailnet VPN. See [Remote access](/gateway/remote) and [Discovery](/gateway/discovery).
+
+## Related
+
+- [Remote access](/gateway/remote)
+- [Trusted proxy auth](/gateway/trusted-proxy-auth)
+- [Gateway protocol](/gateway/protocol)
--- a/docs/gateway/pairing.md
+++ b/docs/gateway/pairing.md
@@ -166,3 +166,9 @@ Security notes:
 - The transport is **stateless**; it does not store membership.
 - If the Gateway is offline or pairing is disabled, nodes cannot pair.
 - If the Gateway is in remote mode, pairing still happens against the remote Gateway’s store.
+
+## Related
+
+- [Channel pairing](/channels/pairing)
+- [Nodes](/nodes)
+- [Devices CLI](/cli/devices)
--- a/docs/gateway/protocol.md
+++ b/docs/gateway/protocol.md
@@ -615,3 +615,8 @@ Migration target:
 This protocol exposes the **full gateway API** (status, channels, models, chat,
 agent, sessions, nodes, approvals, etc.). The exact surface is defined by the
 TypeBox schemas in `src/gateway/protocol/schema.ts`.
+
+## Related
+
+- [Bridge protocol](/gateway/bridge-protocol)
+- [Gateway runbook](/gateway)
--- a/docs/gateway/remote.md
+++ b/docs/gateway/remote.md
@@ -249,3 +249,9 @@ launchctl bootout gui/$UID/ai.openclaw.ssh-tunnel
 | `ssh -N`                             | SSH without executing remote commands (port-forwarding only) |
 | `KeepAlive`                          | Automatically restarts the tunnel if it crashes              |
 | `RunAtLoad`                          | Starts the tunnel when the LaunchAgent loads at login        |
+
+## Related
+
+- [Tailscale](/gateway/tailscale)
+- [Authentication](/gateway/authentication)
+- [Remote gateway setup](/gateway/remote-gateway-readme)
--- a/docs/gateway/tailscale.md
+++ b/docs/gateway/tailscale.md
@@ -134,3 +134,9 @@ Avoid Funnel for browser control; treat node pairing like operator access.
 - `tailscale serve` command: [https://tailscale.com/kb/1242/tailscale-serve](https://tailscale.com/kb/1242/tailscale-serve)
 - Tailscale Funnel overview: [https://tailscale.com/kb/1223/tailscale-funnel](https://tailscale.com/kb/1223/tailscale-funnel)
 - `tailscale funnel` command: [https://tailscale.com/kb/1311/tailscale-funnel](https://tailscale.com/kb/1311/tailscale-funnel)
+
+## Related
+
+- [Remote access](/gateway/remote)
+- [Discovery](/gateway/discovery)
+- [Authentication](/gateway/authentication)
--- a/docs/gateway/troubleshooting.md
+++ b/docs/gateway/troubleshooting.md
@@ -564,3 +564,9 @@ Related:
 - [/gateway/pairing](/gateway/pairing)
 - [/gateway/authentication](/gateway/authentication)
 - [/gateway/background-process](/gateway/background-process)
+
+## Related
+
+- [Gateway runbook](/gateway)
+- [Doctor](/gateway/doctor)
+- [FAQ](/help/faq)
--- a/docs/platforms/android.md
+++ b/docs/platforms/android.md
@@ -240,3 +240,9 @@ Example configuration:
 <Note>
 Notification forwarding requires the Android Notification Listener permission. The app prompts for this during setup.
 </Note>
+
+## Related
+
+- [iOS app](/platforms/ios)
+- [Nodes](/nodes)
+- [Android node troubleshooting](/nodes/troubleshooting)
--- a/docs/platforms/index.md
+++ b/docs/platforms/index.md
@@ -52,3 +52,9 @@ The service target depends on OS:
 - macOS: LaunchAgent (`ai.openclaw.gateway` or `ai.openclaw.<profile>`; legacy `com.openclaw.*`)
 - Linux/WSL2: systemd user service (`openclaw-gateway[-<profile>].service`)
 - Native Windows: Scheduled Task (`OpenClaw Gateway` or `OpenClaw Gateway (<profile>)`), with a per-user Startup-folder login item fallback if task creation is denied
+
+## Related
+
+- [Install overview](/install)
+- [macOS app](/platforms/macos)
+- [iOS app](/platforms/ios)
--- a/docs/platforms/linux.md
+++ b/docs/platforms/linux.md
@@ -133,3 +133,9 @@ its normal score, usually `0`.
 This does not replace normal memory tuning. If a VPS or container repeatedly
 kills children, increase the memory limit, reduce concurrency, or add stronger
 resource controls such as systemd `MemoryMax=` or container-level memory limits.
+
+## Related
+
+- [Install overview](/install)
+- [Linux server](/vps)
+- [Raspberry Pi](/platforms/raspberry-pi)
--- a/docs/platforms/windows.md
+++ b/docs/platforms/windows.md
@@ -247,3 +247,8 @@ Full guide: [Getting Started](/start/getting-started)

 We do not have a Windows companion app yet. Contributions are welcome if you want
 contributions to make it happen.
+
+## Related
+
+- [Install overview](/install)
+- [Platforms](/platforms)