diff --git a/docs/install/azure.md b/docs/install/azure.md index bd438cc352b..23e783d48a2 100644 --- a/docs/install/azure.md +++ b/docs/install/azure.md @@ -309,3 +309,9 @@ This removes the resource group and everything inside it (VM, VNet, NSG, Bastion - Pair local devices as nodes: [Nodes](/nodes) - Configure the Gateway: [Gateway configuration](/gateway/configuration) - For more details on OpenClaw Azure deployment with the GitHub Copilot model provider: [OpenClaw on Azure with GitHub Copilot](https://github.com/johnsonshi/openclaw-azure-github-copilot) + +## Related + +- [Install overview](/install) +- [GCP](/install/gcp) +- [DigitalOcean](/install/digitalocean) diff --git a/docs/install/bun.md b/docs/install/bun.md index dbbd0a4120a..dd30766f879 100644 --- a/docs/install/bun.md +++ b/docs/install/bun.md @@ -51,3 +51,9 @@ bun pm trust @whiskeysockets/baileys protobufjs ## Caveats Some scripts still hardcode pnpm (for example `docs:build`, `ui:*`, `protocol:check`). Run those via pnpm for now. + +## Related + +- [Install overview](/install) +- [Node.js](/install/node) +- [Updating](/install/updating) diff --git a/docs/install/development-channels.md b/docs/install/development-channels.md index b4493e12b26..1d38f82bbd6 100644 --- a/docs/install/development-channels.md +++ b/docs/install/development-channels.md @@ -129,3 +129,8 @@ Beta and dev builds may **not** include a macOS app release. That is OK: - The git tag and npm dist-tag can still be published. - Call out "no macOS build for this beta" in release notes or changelog. + +## Related + +- [Updating](/install/updating) +- [Installer internals](/install/installer) diff --git a/docs/install/digitalocean.md b/docs/install/digitalocean.md index 1a26bed8f04..c4fbf676bf3 100644 --- a/docs/install/digitalocean.md +++ b/docs/install/digitalocean.md @@ -125,3 +125,10 @@ Run a persistent OpenClaw Gateway on a DigitalOcean Droplet. - [Channels](/channels) -- connect Telegram, WhatsApp, Discord, and more - [Gateway configuration](/gateway/configuration) -- all config options - [Updating](/install/updating) -- keep OpenClaw up to date + +## Related + +- [Install overview](/install) +- [Fly.io](/install/fly) +- [Hetzner](/install/hetzner) +- [VPS hosting](/vps) diff --git a/docs/install/docker-vm-runtime.md b/docs/install/docker-vm-runtime.md index 7581448de67..3ef1843848d 100644 --- a/docs/install/docker-vm-runtime.md +++ b/docs/install/docker-vm-runtime.md @@ -138,3 +138,9 @@ git pull docker compose build docker compose up -d ``` + +## Related + +- [Docker](/install/docker) +- [Podman](/install/podman) +- [ClawDock](/install/clawdock) diff --git a/docs/install/exe-dev.md b/docs/install/exe-dev.md index e86502a73ab..0f3ba0f574a 100644 --- a/docs/install/exe-dev.md +++ b/docs/install/exe-dev.md @@ -129,3 +129,8 @@ openclaw health ``` Guide: [Updating](/install/updating) + +## Related + +- [Remote gateway](/gateway/remote) +- [Install overview](/install) diff --git a/docs/install/fly.md b/docs/install/fly.md index 2d65bc69409..c1b74dbcf2e 100644 --- a/docs/install/fly.md +++ b/docs/install/fly.md @@ -502,3 +502,10 @@ See [Fly.io pricing](https://fly.io/docs/about/pricing/) for details. - Set up messaging channels: [Channels](/channels) - Configure the Gateway: [Gateway configuration](/gateway/configuration) - Keep OpenClaw up to date: [Updating](/install/updating) + +## Related + +- [Install overview](/install) +- [Hetzner](/install/hetzner) +- [Docker](/install/docker) +- [VPS hosting](/vps) diff --git a/docs/install/gcp.md b/docs/install/gcp.md index 3736bfbb661..9303d690004 100644 --- a/docs/install/gcp.md +++ b/docs/install/gcp.md @@ -413,3 +413,9 @@ See [https://cloud.google.com/iam/docs/understanding-roles](https://cloud.google - Set up messaging channels: [Channels](/channels) - Pair local devices as nodes: [Nodes](/nodes) - Configure the Gateway: [Gateway configuration](/gateway/configuration) + +## Related + +- [Install overview](/install) +- [Azure](/install/azure) +- [VPS hosting](/vps) diff --git a/docs/install/hetzner.md b/docs/install/hetzner.md index c5f5a4eb45a..aaa19aea56e 100644 --- a/docs/install/hetzner.md +++ b/docs/install/hetzner.md @@ -260,3 +260,10 @@ This approach complements the Docker setup above with reproducible deployments, - Set up messaging channels: [Channels](/channels) - Configure the Gateway: [Gateway configuration](/gateway/configuration) - Keep OpenClaw up to date: [Updating](/install/updating) + +## Related + +- [Install overview](/install) +- [Fly.io](/install/fly) +- [Docker](/install/docker) +- [VPS hosting](/vps) diff --git a/docs/install/hostinger.md b/docs/install/hostinger.md index fdf2db46145..5885d5cdc73 100644 --- a/docs/install/hostinger.md +++ b/docs/install/hostinger.md @@ -90,3 +90,9 @@ Send "Hi" to your assistant on the channel you connected. OpenClaw will reply an - [Channels](/channels) -- connect Telegram, WhatsApp, Discord, and more - [Gateway configuration](/gateway/configuration) -- all config options + +## Related + +- [Install overview](/install) +- [VPS hosting](/vps) +- [DigitalOcean](/install/digitalocean) diff --git a/docs/install/installer.md b/docs/install/installer.md index d157f0c2b7f..83721f7cd76 100644 --- a/docs/install/installer.md +++ b/docs/install/installer.md @@ -439,3 +439,9 @@ Use non-interactive flags/env vars for predictable runs. Usually a PATH issue. See [Node.js troubleshooting](/install/node#troubleshooting). + +## Related + +- [Install overview](/install) +- [Updating](/install/updating) +- [Uninstall](/install/uninstall) diff --git a/docs/install/kubernetes.md b/docs/install/kubernetes.md index 159d3608e91..722c4fc982d 100644 --- a/docs/install/kubernetes.md +++ b/docs/install/kubernetes.md @@ -190,3 +190,9 @@ scripts/k8s/ ├── pvc.yaml # 10Gi persistent storage └── service.yaml # ClusterIP on 18789 ``` + +## Related + +- [Docker](/install/docker) +- [Docker VM runtime](/install/docker-vm-runtime) +- [Install overview](/install) diff --git a/docs/install/migrating.md b/docs/install/migrating.md index 85c76261c5c..a08b279849a 100644 --- a/docs/install/migrating.md +++ b/docs/install/migrating.md @@ -110,3 +110,9 @@ On the new machine, confirm: - [ ] Channels are still connected (no re-pairing needed) - [ ] The dashboard opens and shows existing sessions - [ ] Workspace files (memory, configs) are present + +## Related + +- [Install overview](/install) +- [Matrix migration](/install/migrating-matrix) +- [Uninstall](/install/uninstall) diff --git a/docs/install/oracle.md b/docs/install/oracle.md index 58dce4804f1..55ceaec38bf 100644 --- a/docs/install/oracle.md +++ b/docs/install/oracle.md @@ -154,3 +154,9 @@ Then open `http://localhost:18789`. - [Channels](/channels) -- connect Telegram, WhatsApp, Discord, and more - [Gateway configuration](/gateway/configuration) -- all config options - [Updating](/install/updating) -- keep OpenClaw up to date + +## Related + +- [Install overview](/install) +- [GCP](/install/gcp) +- [VPS hosting](/vps) diff --git a/docs/install/raspberry-pi.md b/docs/install/raspberry-pi.md index 4ee2b522dc0..5d86e47e669 100644 --- a/docs/install/raspberry-pi.md +++ b/docs/install/raspberry-pi.md @@ -155,3 +155,9 @@ sudo systemctl disable bluetooth - [Channels](/channels) -- connect Telegram, WhatsApp, Discord, and more - [Gateway configuration](/gateway/configuration) -- all config options - [Updating](/install/updating) -- keep OpenClaw up to date + +## Related + +- [Install overview](/install) +- [Linux server](/vps) +- [Platforms](/platforms) diff --git a/docs/install/uninstall.md b/docs/install/uninstall.md index e919478d22d..c8c32ea75ee 100644 --- a/docs/install/uninstall.md +++ b/docs/install/uninstall.md @@ -124,3 +124,8 @@ If you run from a repo checkout (`git clone` + `openclaw ...` / `bun run opencla 1. Uninstall the gateway service **before** deleting the repo (use the easy path above or manual service removal). 2. Delete the repo directory. 3. Remove state + workspace as shown above. + +## Related + +- [Install overview](/install) +- [Migration guide](/install/migrating) diff --git a/docs/reference/api-usage-costs.md b/docs/reference/api-usage-costs.md index 8951c3b0c22..7e43cb328fb 100644 --- a/docs/reference/api-usage-costs.md +++ b/docs/reference/api-usage-costs.md @@ -195,3 +195,9 @@ Skills can store `apiKey` in `skills.entries..apiKey`. If a skill uses tha APIs, it can incur costs according to the skill’s provider. See [Skills](/tools/skills). + +## Related + +- [Token use and costs](/reference/token-use) +- [Prompt caching](/reference/prompt-caching) +- [Usage tracking](/concepts/usage-tracking) diff --git a/docs/reference/credits.md b/docs/reference/credits.md index e4376a8706b..12b461eeafa 100644 --- a/docs/reference/credits.md +++ b/docs/reference/credits.md @@ -28,3 +28,8 @@ OpenClaw = CLAW + TARDIS, because every space lobster needs a time and space mac MIT - Free as a lobster in the ocean. > "We are all just playing with our own prompts." (An AI, probably high on tokens) + +## Related + +- [Token use and costs](/reference/token-use) +- [Release policy](/reference/release-policy) diff --git a/docs/reference/device-models.md b/docs/reference/device-models.md index 1ad98590118..b3a5acffd1a 100644 --- a/docs/reference/device-models.md +++ b/docs/reference/device-models.md @@ -45,3 +45,8 @@ curl -fsSL "https://raw.githubusercontent.com/kyle-seongwoo-jun/apple-device-ide ```bash swift build --package-path apps/macos ``` + +## Related + +- [Nodes](/nodes) +- [Node troubleshooting](/nodes/troubleshooting) diff --git a/docs/reference/memory-config.md b/docs/reference/memory-config.md index 8c8f912024b..fdd5667fa7d 100644 --- a/docs/reference/memory-config.md +++ b/docs/reference/memory-config.md @@ -531,3 +531,9 @@ Notes: - Dreaming writes machine state to `memory/.dreams/`. - Dreaming writes human-readable narrative output to `DREAMS.md` (or existing `dreams.md`). - The light/deep/REM phase policy and thresholds are internal behavior, not user-facing config. + +## Related + +- [Memory overview](/concepts/memory) +- [Memory search](/concepts/memory-search) +- [Configuration reference](/gateway/configuration-reference) diff --git a/docs/reference/prompt-caching.md b/docs/reference/prompt-caching.md index da7f835e813..819d3352aab 100644 --- a/docs/reference/prompt-caching.md +++ b/docs/reference/prompt-caching.md @@ -340,3 +340,8 @@ Related docs: - [Token Use and Costs](/reference/token-use) - [Session Pruning](/concepts/session-pruning) - [Gateway Configuration Reference](/gateway/configuration-reference) + +## Related + +- [Token use and costs](/reference/token-use) +- [API usage and costs](/reference/api-usage-costs) diff --git a/docs/reference/rich-output-protocol.md b/docs/reference/rich-output-protocol.md index 2a1eaa74acd..99c0350019d 100644 --- a/docs/reference/rich-output-protocol.md +++ b/docs/reference/rich-output-protocol.md @@ -54,3 +54,8 @@ The normalized/stored assistant content block is a structured `canvas` item: ``` Stored/rendered rich blocks use this `canvas` shape directly. `present_view` is not recognized. + +## Related + +- [RPC adapters](/reference/rpc-adapters) +- [Typebox](/concepts/typebox) diff --git a/docs/reference/rpc.md b/docs/reference/rpc.md index cb68b57f5de..b3581549577 100644 --- a/docs/reference/rpc.md +++ b/docs/reference/rpc.md @@ -39,3 +39,8 @@ See [iMessage](/channels/imessage) for legacy setup and addressing (`chat_id` pr - Gateway owns the process (start/stop tied to provider lifecycle). - Keep RPC clients resilient: timeouts, restart on exit. - Prefer stable IDs (e.g., `chat_id`) over display strings. + +## Related + +- [RPC adapters](/reference/rpc-adapters) +- [Gateway protocol](/gateway/protocol) diff --git a/docs/reference/secretref-credential-surface.md b/docs/reference/secretref-credential-surface.md index 38c9be8e3cd..e822f4b1f3c 100644 --- a/docs/reference/secretref-credential-surface.md +++ b/docs/reference/secretref-credential-surface.md @@ -144,3 +144,8 @@ Out-of-scope credentials include: Rationale: - These credentials are minted, rotated, session-bearing, or OAuth-durable classes that do not fit read-only external SecretRef resolution. + +## Related + +- [Secrets management](/gateway/secrets) +- [Auth credential semantics](/auth-credential-semantics) diff --git a/docs/reference/session-management-compaction.md b/docs/reference/session-management-compaction.md index 6b286f42547..38254eb4b0e 100644 --- a/docs/reference/session-management-compaction.md +++ b/docs/reference/session-management-compaction.md @@ -365,3 +365,9 @@ flush logic lives on the Gateway side today. - compaction settings (`reserveTokens` too high for the model window can cause earlier compaction) - tool-result bloat: enable/tune session pruning - Silent turns leaking? Confirm the reply starts with `NO_REPLY` (case-insensitive exact token) and you’re on a build that includes the streaming suppression fix. + +## Related + +- [Session management](/concepts/session) +- [Session pruning](/concepts/session-pruning) +- [Context engine](/concepts/context-engine) diff --git a/docs/reference/token-use.md b/docs/reference/token-use.md index 0fac4eb9bea..796c5ac9958 100644 --- a/docs/reference/token-use.md +++ b/docs/reference/token-use.md @@ -212,3 +212,9 @@ rejects that combination with HTTP 401. - Prefer smaller models for verbose, exploratory work. See [Skills](/tools/skills) for the exact skill list overhead formula. + +## Related + +- [API usage and costs](/reference/api-usage-costs) +- [Prompt caching](/reference/prompt-caching) +- [Usage tracking](/concepts/usage-tracking)