From 6667f66fd81d0b3442e6a1871ccabd1477a0622f Mon Sep 17 00:00:00 2001 From: Vincent Koc Date: Thu, 23 Apr 2026 15:41:49 -0700 Subject: [PATCH] docs(tools): add Related sections and unify See also to Related --- docs/cli/update.md | 2 +- docs/gateway/openshell.md | 2 +- docs/gateway/sandbox-vs-tool-policy-vs-elevated.md | 2 +- docs/providers/inferrs.md | 2 +- docs/tools/acp-agents.md | 6 ++++++ docs/tools/apply-patch.md | 6 ++++++ docs/tools/browser-linux-troubleshooting.md | 6 ++++++ docs/tools/browser-login.md | 6 ++++++ .../browser-wsl2-windows-remote-cdp-troubleshooting.md | 6 ++++++ docs/tools/capability-cookbook.md | 6 ++++++ docs/tools/clawhub.md | 6 ++++++ docs/tools/code-execution.md | 6 ++++++ docs/tools/llm-task.md | 6 ++++++ docs/tools/loop-detection.md | 6 ++++++ docs/tools/media-overview.md | 7 +++++++ docs/tools/multi-agent-sandbox-tools.md | 2 +- docs/tools/skills-config.md | 6 ++++++ docs/tools/slash-commands.md | 6 ++++++ docs/tools/subagents.md | 6 ++++++ docs/tools/tokenjuice.md | 6 ++++++ docs/tools/trajectory.md | 6 ++++++ docs/tools/tts.md | 6 ++++++ 22 files changed, 108 insertions(+), 5 deletions(-) diff --git a/docs/cli/update.md b/docs/cli/update.md index fd5373236c7..430f832cdf4 100644 --- a/docs/cli/update.md +++ b/docs/cli/update.md @@ -120,7 +120,7 @@ If pnpm bootstrap still fails, the updater now stops early with a package-manage `openclaw --update` rewrites to `openclaw update` (useful for shells and launcher scripts). -## See also +## Related - `openclaw doctor` (offers to run update first on git checkouts) - [Development channels](/install/development-channels) diff --git a/docs/gateway/openshell.md b/docs/gateway/openshell.md index 358c882c198..93093502758 100644 --- a/docs/gateway/openshell.md +++ b/docs/gateway/openshell.md @@ -303,7 +303,7 @@ the intended remote workspace. 5. In `remote` mode: seed once on create, then operate directly on the remote workspace. -## See also +## Related - [Sandboxing](/gateway/sandboxing) -- modes, scopes, and backend comparison - [Sandbox vs Tool Policy vs Elevated](/gateway/sandbox-vs-tool-policy-vs-elevated) -- debugging blocked tools diff --git a/docs/gateway/sandbox-vs-tool-policy-vs-elevated.md b/docs/gateway/sandbox-vs-tool-policy-vs-elevated.md index b57bb6f2b51..c9b673ca273 100644 --- a/docs/gateway/sandbox-vs-tool-policy-vs-elevated.md +++ b/docs/gateway/sandbox-vs-tool-policy-vs-elevated.md @@ -132,7 +132,7 @@ Fix-it keys (pick one): In `"non-main"` mode, group/channel keys are _not_ main. Use the main session key (shown by `sandbox explain`) or switch mode to `"off"`. -## See also +## Related - [Sandboxing](/gateway/sandboxing) -- full sandbox reference (modes, scopes, backends, images) - [Multi-Agent Sandbox & Tools](/tools/multi-agent-sandbox-tools) -- per-agent overrides and precedence diff --git a/docs/providers/inferrs.md b/docs/providers/inferrs.md index 89c85ac898e..11817c3a65d 100644 --- a/docs/providers/inferrs.md +++ b/docs/providers/inferrs.md @@ -193,7 +193,7 @@ This example uses Gemma 4 on a local `inferrs` server. For general help, see [Troubleshooting](/help/troubleshooting) and [FAQ](/help/faq). -## See also +## Related diff --git a/docs/tools/acp-agents.md b/docs/tools/acp-agents.md index a30dcbe8511..3aaaeb24afa 100644 --- a/docs/tools/acp-agents.md +++ b/docs/tools/acp-agents.md @@ -800,3 +800,9 @@ Restart the gateway after changing these values. | `AcpRuntimeError: Permission prompt unavailable in non-interactive mode` | `permissionMode` blocks writes/exec in non-interactive ACP session. | Set `plugins.entries.acpx.config.permissionMode` to `approve-all` and restart gateway. See [Permission configuration](#permission-configuration). | | ACP session fails early with little output | Permission prompts are blocked by `permissionMode`/`nonInteractivePermissions`. | Check gateway logs for `AcpRuntimeError`. For full permissions, set `permissionMode=approve-all`; for graceful degradation, set `nonInteractivePermissions=deny`. | | ACP session stalls indefinitely after completing work | Harness process finished but ACP session did not report completion. | Monitor with `ps aux \| grep acpx`; kill stale processes manually. | + +## Related + +- [Sub-agents](/tools/subagents) +- [Multi-agent sandbox tools](/tools/multi-agent-sandbox-tools) +- [Agent send](/tools/agent-send) diff --git a/docs/tools/apply-patch.md b/docs/tools/apply-patch.md index 642a341374b..36068c6e2ff 100644 --- a/docs/tools/apply-patch.md +++ b/docs/tools/apply-patch.md @@ -48,3 +48,9 @@ The tool accepts a single `input` string that wraps one or more file operations: "input": "*** Begin Patch\n*** Update File: src/index.ts\n@@\n-const foo = 1\n+const foo = 2\n*** End Patch" } ``` + +## Related + +- [Diffs](/tools/diffs) +- [Exec tool](/tools/exec) +- [Code execution](/tools/code-execution) diff --git a/docs/tools/browser-linux-troubleshooting.md b/docs/tools/browser-linux-troubleshooting.md index 4986bf2b17b..4e95ea52a84 100644 --- a/docs/tools/browser-linux-troubleshooting.md +++ b/docs/tools/browser-linux-troubleshooting.md @@ -143,3 +143,9 @@ Notes: - Remote CDP profiles accept `http://`, `https://`, `ws://`, and `wss://`. Use HTTP(S) for `/json/version` discovery, or WS(S) when your browser service gives you a direct DevTools socket URL. + +## Related + +- [Browser](/tools/browser) +- [Browser login](/tools/browser-login) +- [Browser WSL2 troubleshooting](/tools/browser-wsl2-windows-remote-cdp-troubleshooting) diff --git a/docs/tools/browser-login.md b/docs/tools/browser-login.md index 55fb4b19685..b320db4b0eb 100644 --- a/docs/tools/browser-login.md +++ b/docs/tools/browser-login.md @@ -71,3 +71,9 @@ openclaw browser open https://x.com --browser-profile openclaw --target host ``` Or disable sandboxing for the agent that posts updates. + +## Related + +- [Browser](/tools/browser) +- [Browser Linux troubleshooting](/tools/browser-linux-troubleshooting) +- [Browser WSL2 troubleshooting](/tools/browser-wsl2-windows-remote-cdp-troubleshooting) diff --git a/docs/tools/browser-wsl2-windows-remote-cdp-troubleshooting.md b/docs/tools/browser-wsl2-windows-remote-cdp-troubleshooting.md index 3069351fa45..fd6db917948 100644 --- a/docs/tools/browser-wsl2-windows-remote-cdp-troubleshooting.md +++ b/docs/tools/browser-wsl2-windows-remote-cdp-troubleshooting.md @@ -217,3 +217,9 @@ When in doubt: - verify the Windows Chrome endpoint locally first - verify the same endpoint from WSL2 second - only then debug OpenClaw config or Control UI auth + +## Related + +- [Browser](/tools/browser) +- [Browser login](/tools/browser-login) +- [Browser Linux troubleshooting](/tools/browser-linux-troubleshooting) diff --git a/docs/tools/capability-cookbook.md b/docs/tools/capability-cookbook.md index 6b0967bcfd9..09eb06029d4 100644 --- a/docs/tools/capability-cookbook.md +++ b/docs/tools/capability-cookbook.md @@ -115,3 +115,9 @@ Before shipping a new capability, verify: If a PR skips the capability layer and hardcodes vendor behavior into a channel/tool, send it back and define the contract first. + +## Related + +- [Plugin](/tools/plugin) +- [Creating skills](/tools/creating-skills) +- [Tools and plugins](/tools) diff --git a/docs/tools/clawhub.md b/docs/tools/clawhub.md index 968b7502ff5..4fd3702b45f 100644 --- a/docs/tools/clawhub.md +++ b/docs/tools/clawhub.md @@ -350,3 +350,9 @@ export CLAWHUB_DISABLE_TELEMETRY=1 - `CLAWHUB_CONFIG_PATH`: Override where the CLI stores the token/config. - `CLAWHUB_WORKDIR`: Override the default workdir. - `CLAWHUB_DISABLE_TELEMETRY=1`: Disable telemetry on `sync`. + +## Related + +- [Plugin](/tools/plugin) +- [Skills](/tools/skills) +- [Community plugins](/plugins/community) diff --git a/docs/tools/code-execution.md b/docs/tools/code-execution.md index fda4eb778e0..b9e8645712f 100644 --- a/docs/tools/code-execution.md +++ b/docs/tools/code-execution.md @@ -86,3 +86,9 @@ the full analysis request and any inline data in one prompt. - [Web tools](/tools/web) - [Exec](/tools/exec) - [xAI](/providers/xai) + +## Related + +- [Exec tool](/tools/exec) +- [Exec approvals](/tools/exec-approvals) +- [apply_patch tool](/tools/apply-patch) diff --git a/docs/tools/llm-task.md b/docs/tools/llm-task.md index 78d8123d867..b96cd12d0b3 100644 --- a/docs/tools/llm-task.md +++ b/docs/tools/llm-task.md @@ -115,3 +115,9 @@ openclaw.invoke --tool llm-task --action json --args-json '{ - No tools are exposed to the model for this run. - Treat output as untrusted unless you validate with `schema`. - Put approvals before any side-effecting step (send, post, exec). + +## Related + +- [Thinking levels](/tools/thinking) +- [Sub-agents](/tools/subagents) +- [Slash commands](/tools/slash-commands) diff --git a/docs/tools/loop-detection.md b/docs/tools/loop-detection.md index 3a6c09f24c7..18617c04826 100644 --- a/docs/tools/loop-detection.md +++ b/docs/tools/loop-detection.md @@ -96,3 +96,9 @@ This protects users from runaway token spend and lockups while preserving normal - `tools.loopDetection` is merged with agent-level overrides. - Per-agent config fully overrides or extends global values. - If no config exists, guardrails stay off. + +## Related + +- [Exec approvals](/tools/exec-approvals) +- [Thinking levels](/tools/thinking) +- [Sub-agents](/tools/subagents) diff --git a/docs/tools/media-overview.md b/docs/tools/media-overview.md index fe62883af98..d53d67b2482 100644 --- a/docs/tools/media-overview.md +++ b/docs/tools/media-overview.md @@ -72,3 +72,10 @@ voice contract can represent it. - [Music Generation](/tools/music-generation) -- creating music and audio tracks - [Text-to-Speech](/tools/tts) -- converting replies to spoken audio - [Media Understanding](/nodes/media-understanding) -- understanding inbound images, audio, and video + +## Related + +- [Image generation](/tools/image-generation) +- [Video generation](/tools/video-generation) +- [Music generation](/tools/music-generation) +- [Text-to-speech](/tools/tts) diff --git a/docs/tools/multi-agent-sandbox-tools.md b/docs/tools/multi-agent-sandbox-tools.md index 646d4936d34..5eaf35ffa87 100644 --- a/docs/tools/multi-agent-sandbox-tools.md +++ b/docs/tools/multi-agent-sandbox-tools.md @@ -363,7 +363,7 @@ After configuring multi-agent sandbox and tools: --- -## See also +## Related - [Sandboxing](/gateway/sandboxing) -- full sandbox reference (modes, scopes, backends, images) - [Sandbox vs Tool Policy vs Elevated](/gateway/sandbox-vs-tool-policy-vs-elevated) -- debugging "why is this blocked?" diff --git a/docs/tools/skills-config.md b/docs/tools/skills-config.md index ddc5cdfd45d..79cad91324e 100644 --- a/docs/tools/skills-config.md +++ b/docs/tools/skills-config.md @@ -129,3 +129,9 @@ Use one of: - bake the env into your custom sandbox image or remote sandbox environment Global `env` and `skills.entries..env/apiKey` apply to **host** runs only. + +## Related + +- [Skills](/tools/skills) +- [Creating skills](/tools/creating-skills) +- [Slash commands](/tools/slash-commands) diff --git a/docs/tools/slash-commands.md b/docs/tools/slash-commands.md index 6027771dd07..55bebde6c3e 100644 --- a/docs/tools/slash-commands.md +++ b/docs/tools/slash-commands.md @@ -384,3 +384,9 @@ Example: See [BTW Side Questions](/tools/btw) for the full behavior and client UX details. + +## Related + +- [Skills](/tools/skills) +- [Skills config](/tools/skills-config) +- [Creating skills](/tools/creating-skills) diff --git a/docs/tools/subagents.md b/docs/tools/subagents.md index 3d74d951c63..96e53d4cf9c 100644 --- a/docs/tools/subagents.md +++ b/docs/tools/subagents.md @@ -343,3 +343,9 @@ Sub-agents use a dedicated in-process queue lane: - Sub-agent context only injects `AGENTS.md` + `TOOLS.md` (no `SOUL.md`, `IDENTITY.md`, `USER.md`, `HEARTBEAT.md`, or `BOOTSTRAP.md`). - Maximum nesting depth is 5 (`maxSpawnDepth` range: 1–5). Depth 2 is recommended for most use cases. - `maxChildrenPerAgent` caps active children per session (default: 5, range: 1–20). + +## Related + +- [ACP agents](/tools/acp-agents) +- [Multi-agent sandbox tools](/tools/multi-agent-sandbox-tools) +- [Agent send](/tools/agent-send) diff --git a/docs/tools/tokenjuice.md b/docs/tools/tokenjuice.md index c642b0de87f..adbfbe06f31 100644 --- a/docs/tools/tokenjuice.md +++ b/docs/tools/tokenjuice.md @@ -72,3 +72,9 @@ Or: ```bash openclaw plugins disable tokenjuice ``` + +## Related + +- [Exec tool](/tools/exec) +- [Thinking levels](/tools/thinking) +- [Context engine](/concepts/context-engine) diff --git a/docs/tools/trajectory.md b/docs/tools/trajectory.md index 8124be988af..8e22dd5bebc 100644 --- a/docs/tools/trajectory.md +++ b/docs/tools/trajectory.md @@ -180,3 +180,9 @@ If the command rejects the output path: If the export fails with a size error, the session or sidecar exceeded the export safety limits. Start a new session or export a smaller reproduction. + +## Related + +- [Diffs](/tools/diffs) +- [Session management](/concepts/session) +- [Exec tool](/tools/exec) diff --git a/docs/tools/tts.md b/docs/tools/tts.md index a5bc06bb2ea..1a2d9a1c6d5 100644 --- a/docs/tools/tts.md +++ b/docs/tools/tts.md @@ -520,3 +520,9 @@ Gateway methods: - `tts.convert` - `tts.setProvider` - `tts.providers` + +## Related + +- [Media overview](/tools/media-overview) +- [Music generation](/tools/music-generation) +- [Video generation](/tools/video-generation)