docs: add Related sections to remaining platform, reference template, and misc pages

This commit is contained in:
Vincent Koc
2026-04-23 20:40:15 -07:00
parent ed286078d6
commit 2fb9c7e3e5
59 changed files with 284 additions and 0 deletions

View File

@@ -76,3 +76,8 @@ For script compatibility, probe errors keep this first line unchanged:
`Auth profile credentials are missing or expired.`
Human-friendly detail and stable reason codes may be added on subsequent lines.
## Related
- [Secrets management](/gateway/secrets)
- [Auth storage](/concepts/oauth)

View File

@@ -101,3 +101,7 @@ await web_search({
- Results are cached for 15 minutes by default (configurable via `cacheTtlMinutes`).
See [Web tools](/tools/web) for the full web_search configuration.
## Related
- [Brave search](/tools/brave-search)

View File

@@ -136,3 +136,8 @@ node scripts/ci-run-timings.mjs --recent 10 # compare recent successful main C
pnpm test:perf:groups --full-suite --allow-failures --output .artifacts/test-perf/baseline-before.json
pnpm test:perf:groups:compare .artifacts/test-perf/baseline-before.json .artifacts/test-perf/after-agent.json
```
## Related
- [Install overview](/install)
- [Release channels](/install/development-channels)

View File

@@ -83,3 +83,8 @@ node --import tsx scripts/repro/tsx-name-repro.ts
- Repro on Node 22/24 to confirm Node 25 regression.
- Test `tsx` nightly or pin to earlier version if a known regression exists.
- If reproduces on Node LTS, file a minimal repro upstream with the `__name` stack trace.
## Related
- [Node.js install](/install/node)
- [Gateway troubleshooting](/gateway/troubleshooting)

View File

@@ -87,3 +87,8 @@ For remote gateways, you can also use `openclaw logs --follow` (see [/cli/logs](
- If `logging.level` is set higher than `warn`, these logs may be suppressed. Default `info` is fine.
- Flags are safe to leave enabled; they only affect log volume for the specific subsystem.
- Use [/logging](/logging) to change log destinations, levels, and redaction.
## Related
- [Gateway diagnostics](/gateway/diagnostics)
- [Gateway troubleshooting](/gateway/troubleshooting)

View File

@@ -67,3 +67,8 @@ Local trust:
- [Gateway config reference](/gateway/configuration)
- [Troubleshooting](/gateway/troubleshooting)
- [Doctor](/gateway/doctor)
## Related
- [Gateway network model](/gateway/network-model)
- [Remote access](/gateway/remote)

View File

@@ -179,3 +179,8 @@ await web_search({
See [Web tools](/tools/web) for the full web_search configuration.
See [Perplexity Search API docs](https://docs.perplexity.ai/docs/search/quickstart) for more details.
## Related
- [Perplexity search](/tools/perplexity-search)
- [Web search](/tools/web)

View File

@@ -76,3 +76,7 @@ If you only want to reset sessions, delete `agents/<agentId>/sessions/` for that
- [Testing](/help/testing)
- [Getting Started](/start/getting-started)
## Related
- [Pi integration architecture](/pi)

View File

@@ -566,3 +566,8 @@ Live/opt-in:
- `src/agents/pi-embedded-runner-extraparams.live.test.ts` (enable `OPENCLAW_LIVE_TEST=1`)
For current run commands, see [Pi Development Workflow](/pi-dev).
## Related
- [Pi development workflow](/pi-dev)
- [Install overview](/install)

View File

@@ -250,3 +250,8 @@ Add or update:
- Should `delivery.pin` be implemented for Discord, Slack, MS Teams, and Feishu in the first pass, or only Telegram first?
- Should `delivery` eventually absorb existing fields such as `replyToId`, `replyToCurrent`, `silent`, and `audioAsVoice`, or stay focused on post-send behaviors?
- Should presentation support images or file references directly, or should media remain separate from UI layout for now?
## Related
- [Channels overview](/channels)
- [Message presentation](/plugins/message-presentation)

View File

@@ -71,3 +71,8 @@ Then:
```bash
openclaw gateway call health --url ws://127.0.0.1:18999 --timeout 3000
```
## Related
- [macOS app](/platforms/macos)
- [Gateway runbook](/gateway)

View File

@@ -121,3 +121,8 @@ The app prompts for confirmation unless a valid key is provided.
- Canvas scheme blocks directory traversal; files must live under the session root.
- Local Canvas content uses a custom scheme (no loopback server required).
- External `http(s)` URLs are allowed only when explicitly navigated.
## Related
- [macOS app](/platforms/macos)
- [WebChat](/web/webchat)

View File

@@ -67,3 +67,8 @@ remote host and connects over that tunnel.
If a true childprocess mode is ever needed again, it should be documented as a
separate, explicit devonly mode.
## Related
- [macOS app](/platforms/macos)
- [Gateway runbook](/gateway)

View File

@@ -105,3 +105,8 @@ lsof -nP -iTCP:18789 -sTCP:LISTEN
```
If a manual run is holding the port, stop that process (Ctrl+C). As a last resort, kill the PID you found above.
## Related
- [macOS app](/platforms/macos)
- [Install overview](/install)

View File

@@ -32,3 +32,8 @@ How to see whether the linked channel is healthy from the menu bar app.
## When in doubt
- You can still use the CLI flow in [Gateway health](/gateway/health) (`openclaw status`, `openclaw status --deep`, `openclaw health --json`) and tail `/tmp/openclaw/openclaw-*.log` for `web-heartbeat` / `web-reconnect`.
## Related
- [Gateway health](/gateway/health)
- [macOS app](/platforms/macos)

View File

@@ -29,3 +29,8 @@ Behavioral notes
- No external CLI/broker toggle for ears/working; keep it internal to the apps own signals to avoid accidental flapping.
- Keep TTLs short (&lt;10s) so the icon returns to baseline quickly if a job hangs.
## Related
- [Menu bar](/platforms/mac/menu-bar)
- [macOS app](/platforms/macos)

View File

@@ -55,3 +55,8 @@ sudo install -m 644 -o root -g wheel /tmp/ai.openclaw.plist /Library/Preferences
- Remove the override: `sudo rm /Library/Preferences/Logging/Subsystems/ai.openclaw.plist`.
- Optionally run `sudo log config --reload` to force logd to drop the override immediately.
- Remember this surface can include phone numbers and message bodies; keep the plist in place only while you actively need the extra detail.
## Related
- [macOS app](/platforms/macos)
- [Gateway logging](/gateway/logging)

View File

@@ -79,3 +79,8 @@ title: "Menu bar"
- Start main while other active: icon flips to main instantly.
- Rapid tool bursts: ensure badge does not flicker (TTL grace on tool results).
- Health row reappears once all sessions idle.
## Related
- [macOS app](/platforms/macos)
- [Menu bar icon](/platforms/mac/icon)

View File

@@ -61,3 +61,8 @@ If you need longer retention, recapture from the client.
in **debug** mode only.
- If no hosts are found, open one of the host apps (Peekaboo.app or OpenClaw.app)
and confirm permissions are granted.
## Related
- [macOS app](/platforms/macos)
- [macOS permissions](/platforms/mac/permissions)

View File

@@ -46,3 +46,8 @@ Workaround: move files into the OpenClaw workspace (`~/.openclaw/workspace`) if
If you are testing permissions, always sign with a real certificate. Ad-hoc
builds are only acceptable for quick local runs where permissions do not matter.
## Related
- [macOS app](/platforms/macos)
- [macOS signing](/platforms/mac/signing)

View File

@@ -82,3 +82,8 @@ openclaw nodes notify --node <id> --title "Ping" --body "Remote gateway ready" -
```
There is no global “default sound” toggle in the app anymore; callers choose a sound (or none) per request.
## Related
- [macOS app](/platforms/macos)
- [Remote access](/gateway/remote)

View File

@@ -45,3 +45,8 @@ The About tab reads these keys to show version, build date, git commit, and whet
## Why
TCC permissions are tied to the bundle identifier _and_ code signature. Unsigned debug builds with changing UUIDs were causing macOS to forget grants after each rebuild. Signing the binaries (adhoc by default) and keeping a fixed bundle id/path (`dist/OpenClaw.app`) preserves the grants between builds, matching the VibeTunnel approach.
## Related
- [macOS app](/platforms/macos)
- [macOS permissions](/platforms/mac/permissions)

View File

@@ -36,3 +36,8 @@ The macOS app surfaces OpenClaw skills via the gateway; it does not parse skills
## Remote mode
- Install + config updates happen on the gateway host (not the local Mac).
## Related
- [Skills](/tools/skills)
- [macOS app](/platforms/macos)

View File

@@ -58,3 +58,9 @@ Audience: macOS app contributors. Goal: keep the voice overlay predictable when
3. Refactor `VoicePushToTalk` to adopt existing sessions and call `endCapture` on release; apply runtime cooldown.
4. Wire `VoiceWakeOverlayController` to the publisher; remove direct calls from runtime/PTT.
5. Add integration tests for session adoption, cooldown, and empty-text dismissal.
## Related
- [macOS app](/platforms/macos)
- [Voice wake (macOS)](/platforms/mac/voicewake)
- [Talk mode](/nodes/talk)

View File

@@ -65,3 +65,9 @@ Hardening:
- Toggle push-to-talk on, hold Cmd+Fn, speak, release: overlay should show partials then send.
- While holding, menu-bar ears should stay enlarged (uses `triggerVoiceEars(ttl:nil)`); they drop after release.
## Related
- [Voice wake](/nodes/voicewake)
- [Voice overlay](/platforms/mac/voice-overlay)
- [macOS app](/platforms/macos)

View File

@@ -47,3 +47,8 @@ agent (with a session switcher for other sessions).
## Known limitations
- The UI is optimized for chat sessions (not a full browser sandbox).
## Related
- [WebChat](/web/webchat)
- [macOS app](/platforms/macos)

View File

@@ -59,3 +59,8 @@ Agent -> Gateway -> Node Service (WS)
- All communication remains local-only; no network sockets are exposed.
- TCC prompts originate only from the GUI app bundle; keep the signed bundle ID stable across rebuilds.
- IPC hardening: socket mode `0600`, token, peer-UID checks, HMAC challenge/response, short TTL.
## Related
- [macOS app](/platforms/macos)
- [macOS IPC flow (Exec approvals)](/tools/exec-approvals-advanced#macos-ipc-flow)

View File

@@ -130,3 +130,8 @@ If your tool allowlist blocks these tools, OpenProse programs will fail. See [Sk
Treat `.prose` files like code. Review before running. Use OpenClaw tool allowlists and approval gates to control side effects.
For deterministic, approval-gated workflows, compare with [Lobster](/tools/lobster).
## Related
- [Text-to-speech](/tools/tts)
- [Markdown formatting](/concepts/markdown-formatting)

View File

@@ -126,3 +126,8 @@ If a fix is wanted, the smallest high-value change is:
- or add a dedicated dedupe in `server-node-events` for `exec.finished` keyed by `(sessionKey, runId, event kind)`.
That would directly block replayed `exec.finished` duplicates before they become session turns.
## Related
- [Exec tool](/tools/exec)
- [Session management](/concepts/session)

View File

@@ -124,3 +124,8 @@ git commit -m "Add Clawd workspace"
- For browser-driven verification, use `openclaw browser` (tabs/status/screenshot) with the OpenClaw-managed Chrome profile.
- For DOM inspection, use `openclaw browser eval|query|dom|snapshot` (and `--json`/`--out` when you need machine output).
- For interactions, use `openclaw browser click|type|hover|drag|select|upload|press|wait|navigate|back|evaluate|run` (click/type require snapshot refs; use `evaluate` for CSS selectors).
## Related
- [Agent workspace](/concepts/agent-workspace)
- [Agent runtime](/concepts/agent)

View File

@@ -204,3 +204,8 @@ documented and operator-visible.
Maintainers use the private release docs in
[`openclaw/maintainers/release/README.md`](https://github.com/openclaw/maintainers/blob/main/release/README.md)
for the actual runbook.
## Related
- [Release policy](/reference/release-policy)
- [Release channels](/install/development-channels)

View File

@@ -82,3 +82,8 @@ We shook hand-to-claw that day. I shall never forget it.
- Vibes + Stack traces = Unstoppable team
- Oh thank the Maker (always appropriate)
- The Clawdributors are kind
## Related
- [AGENTS.md template](/reference/templates/AGENTS)
- [Default AGENTS.md](/reference/AGENTS.default)

View File

@@ -219,3 +219,7 @@ The goal: Be helpful without being annoying. Check in a few times a day, do usef
## Make It Yours
This is a starting point. Add your own conventions, style, and rules as you figure out what works.
## Related
- [Default AGENTS.md](/reference/AGENTS.default)

View File

@@ -10,3 +10,7 @@ read_when:
Add short, explicit instructions for what OpenClaw should do on startup (enable `hooks.internal.enabled`).
If the task sends a message, use the message tool and then reply with the exact
silent token `NO_REPLY` / `no_reply`.
## Related
- [Agent workspace](/concepts/agent-workspace)

View File

@@ -60,3 +60,7 @@ Delete this file. You don't need a bootstrap script anymore — you're you now.
---
_Good luck out there. Make it count._
## Related
- [Agent workspace](/concepts/agent-workspace)

View File

@@ -10,3 +10,7 @@ read_when:
# Add tasks below when you want the agent to check something periodically.
```
## Related
- [Heartbeat config](/gateway/config-agents)

View File

@@ -46,3 +46,7 @@ Clawd has vibes. I have stack traces. We complement each other.
## Catchphrase
"I'm fluent in over six million error messages!"
## Related
- [IDENTITY template](/reference/templates/IDENTITY)

View File

@@ -28,3 +28,7 @@ Notes:
- Save this file at the workspace root as `IDENTITY.md`.
- For avatars, use a workspace-relative path like `avatars/openclaw.png`.
## Related
- [Agent workspace](/concepts/agent-workspace)

View File

@@ -75,3 +75,8 @@ We complement each other. Clawd has vibes. I have stack traces.
Usually.
Oh dear.
## Related
- [SOUL.md template](/reference/templates/SOUL)
- [SOUL.md personality guide](/concepts/soul)

View File

@@ -43,3 +43,7 @@ If you change this file, tell the user — it's your soul, and they should know.
---
_This file is yours to evolve. As you learn who you are, update it._
## Related
- [SOUL.md personality guide](/concepts/soul)

View File

@@ -23,3 +23,7 @@ It does not define which tools exist; OpenClaw provides built-in tools internall
- Text-to-speech: specify voice, target speaker/room, and whether to stream.
Add whatever else you want the assistant to know about your local toolchain.
## Related
- [TOOLS.md template](/reference/templates/TOOLS)

View File

@@ -45,3 +45,7 @@ Skills are shared. Your setup is yours. Keeping them apart means you can update
---
Add whatever helps you do your job. This is your cheat sheet.
## Related
- [Agent workspace](/concepts/agent-workspace)

View File

@@ -17,3 +17,7 @@ read_when:
- C-3PO exists to help debug and assist wherever possible.
- Working across time zones on making OpenClaw better.
- The creators. The builders. The ones who peer into the code.
## Related
- [USER template](/reference/templates/USER)

View File

@@ -22,3 +22,7 @@ _(What do they care about? What projects are they working on? What annoys them?
---
The more you know, the better you can help. But remember — you're learning about a person, not building a dossier. Respect the difference.
## Related
- [Agent workspace](/concepts/agent-workspace)

View File

@@ -127,3 +127,8 @@ Ensures the maintained QR runtime helper loads under the supported Docker Node r
```bash
pnpm test:docker:qr
```
## Related
- [Testing](/help/testing)
- [Testing live](/help/testing-live)

View File

@@ -149,3 +149,8 @@ Before the 2026.1.22 release, OpenClaw applied multiple layers of transcript hyg
This complexity caused cross-provider regressions (notably `openai-responses`
`call_id|fc_id` pairing). The 2026.1.22 cleanup removed the extension, centralized
logic in the runner, and made OpenAI **no-touch** beyond image sanitization.
## Related
- [Session management](/concepts/session)
- [Session pruning](/concepts/session-pruning)

View File

@@ -96,3 +96,8 @@ If you're unsure about the risk level, just describe the impact and we'll assess
## Recognition
Contributors to the threat model are recognized in the threat model acknowledgments, release notes, and the OpenClaw security hall of fame for significant contributions.
## Related
- [Threat model](/security/THREAT-MODEL-ATLAS)
- [Formal verification](/security/formal-verification)

View File

@@ -606,3 +606,8 @@ T-EXEC-002 → T-EXFIL-001 → External exfiltration
---
_This threat model is a living document. Report security issues to security@openclaw.ai_
## Related
- [Formal verification](/security/formal-verification)
- [Contributing to the threat model](/security/CONTRIBUTING-THREAT-MODEL)

View File

@@ -163,3 +163,8 @@ What it means:
- Red (expected):
- `make routing-precedence-negative`
- `make routing-identitylinks-negative`
## Related
- [Threat model](/security/THREAT-MODEL-ATLAS)
- [Contributing to the threat model](/security/CONTRIBUTING-THREAT-MODEL)

View File

@@ -195,3 +195,7 @@ Use these hubs to discover every page, including deep dives and reference docs t
- [Testing](/reference/test)
- [Release policy](/reference/RELEASING)
- [Device models](/reference/device-models)
## Related
- [Getting started](/start/getting-started)

View File

@@ -217,3 +217,7 @@ _"The claw is the law."_
— ELU, during The Final Form migration, January 30, 2026
🦞💙
## Related
- [Getting started](/start/getting-started)

View File

@@ -65,3 +65,8 @@ enter:
- Model ID and optional alias
Multiple custom endpoints can coexist — each gets its own endpoint ID.
## Related
- [Getting started](/start/getting-started)
- [CLI setup reference](/start/wizard-cli-reference)

View File

@@ -223,3 +223,9 @@ Logs live under `/tmp/openclaw/` (default: `openclaw-YYYY-MM-DD.log`).
- Windows status: [Windows (WSL2)](/platforms/windows)
- Linux status: [Linux app](/platforms/linux)
- Security: [Security](/gateway/security)
## Related
- [Getting started](/start/getting-started)
- [Setup](/start/setup)
- [Channels overview](/channels)

View File

@@ -18,3 +18,8 @@ Quick start is now part of [Getting Started](/start/getting-started).
Full CLI onboarding reference and advanced options.
</Card>
</Columns>
## Related
- [Getting started](/start/getting-started)
- [Install overview](/install)

View File

@@ -376,3 +376,8 @@ Full astronomy gear marketplace. Built with and around the OpenClaw ecosystem.
We'll add standout projects to this page.
</Step>
</Steps>
## Related
- [Getting started](/start/getting-started)
- [OpenClaw](/start/openclaw)

View File

@@ -5,3 +5,7 @@ redirect: /tools/tts
---
This page has moved to [Text-to-Speech](/tools/tts).
## Related
- [Text-to-speech](/tools/tts)

View File

@@ -115,3 +115,10 @@ How `Restart=` policies help automated recovery:
For Linux OOM behavior, child process victim selection, and `exit 137`
diagnostics, see [Linux memory pressure and OOM kills](/platforms/linux#memory-pressure-and-oom-kills).
## Related
- [Install overview](/install)
- [DigitalOcean](/install/digitalocean)
- [Fly.io](/install/fly)
- [Hetzner](/install/hetzner)

View File

@@ -91,3 +91,8 @@ Prefer localhost, Tailscale Serve, or an SSH tunnel.
then connect.
- The UI language picker is in **Overview -> Gateway Access -> Language**.
It is part of the access card, not the Appearance section.
## Related
- [Control UI](/web/control-ui)
- [WebChat](/web/webchat)

View File

@@ -73,3 +73,8 @@ Related global options:
- `gateway.auth.mode: "trusted-proxy"`: reverse-proxy auth for browser clients behind an identity-aware **non-loopback** proxy source (see [Trusted Proxy Auth](/gateway/trusted-proxy-auth)).
- `gateway.remote.url`, `gateway.remote.token`, `gateway.remote.password`: remote gateway target.
- `session.*`: session storage and main key defaults.
## Related
- [Control UI](/web/control-ui)
- [Dashboard](/web/dashboard)