mirror of
https://fastgit.cc/github.com/openclaw/openclaw
synced 2026-05-01 06:36:23 +08:00
docs: unify casing and replace path-as-text links across recent doc surfaces
Sweep recent (last ~5h) doc edits for two readability/uniformity issues: - Replace 42 path-as-text links of the form '[/foo/bar](/foo/bar)' with descriptive labels derived from each target page's frontmatter title (e.g. '[Anthropic]', '[Token use and costs]', '[OpenAI-compatible endpoints]'). Affected files include gateway/troubleshooting, concepts/oauth, reference/session-management-compaction, and reference/transcript-hygiene. - Sentence-case Title-Cased headings and link text in Related sections across codex-harness, model-providers, tools/plugin, sdk-runtime, sdk-setup, prompt-caching, ci, cli/config, google-meet, browser, rich-output-protocol, subagents, web/control-ui, while preserving brand and proper-noun capitalization (OpenAI, Codex, Chrome, Parallels, Z.AI, etc.).
This commit is contained in:
Vincent Koc
@@ -79,7 +79,7 @@ gh workflow run duplicate-after-merge.yml \
|
||||
| `android` | Android unit tests for both flavors plus one debug APK build | Android-relevant changes |
|
||||
| `test-performance-agent` | Daily Codex slow-test optimization after trusted activity | Main CI success or manual dispatch |
|
||||
|
||||
## Fail-Fast Order
|
||||
## Fail-fast order
|
||||
|
||||
Jobs are ordered so cheap checks fail before expensive ones run:
|
||||
|
||||
|
||||
@@ -186,7 +186,7 @@ openclaw config set secrets.providers.vaultfile \
|
||||
--strict-json
|
||||
```
|
||||
|
||||
## Provider Builder Flags
|
||||
## Provider builder flags
|
||||
|
||||
Provider builder targets must use `secrets.providers.<alias>` as the path.
|
||||
|
||||
@@ -279,7 +279,7 @@ Dry-run behavior:
|
||||
- `skippedExecRefs`: number of exec refs skipped because `--allow-exec` was not set
|
||||
- `errors`: structured schema/resolvability failures when `ok=false`
|
||||
|
||||
### JSON Output Shape
|
||||
### JSON output shape
|
||||
|
||||
```json5
|
||||
{
|
||||
|
||||
@@ -7,7 +7,7 @@ title: "Model providers"
|
||||
---
|
||||
|
||||
This page covers **LLM/model providers** (not chat channels like WhatsApp/Telegram).
|
||||
For model selection rules, see [/concepts/models](/concepts/models).
|
||||
For model selection rules, see [Models](/concepts/models).
|
||||
|
||||
## Quick rules
|
||||
|
||||
@@ -160,7 +160,7 @@ OpenClaw ships with the pi‑ai catalog. These providers require **no**
|
||||
|
||||
- [Qwen Cloud](/providers/qwen): Qwen Cloud provider surface plus Alibaba DashScope and Coding Plan endpoint mapping
|
||||
- [MiniMax](/providers/minimax): MiniMax Coding Plan OAuth or API key access
|
||||
- [GLM Models](/providers/glm): Z.AI Coding Plan or general API endpoints
|
||||
- [GLM models](/providers/glm): Z.AI Coding Plan or general API endpoints
|
||||
|
||||
### OpenCode
|
||||
|
||||
@@ -646,11 +646,11 @@ openclaw models set opencode/claude-opus-4-6
|
||||
openclaw models list
|
||||
```
|
||||
|
||||
See also: [/gateway/configuration](/gateway/configuration) for full configuration examples.
|
||||
See also: [Configuration](/gateway/configuration) for full configuration examples.
|
||||
|
||||
## Related
|
||||
|
||||
- [Models](/concepts/models) — model configuration and aliases
|
||||
- [Model Failover](/concepts/model-failover) — fallback chains and retry behavior
|
||||
- [Configuration Reference](/gateway/config-agents#agent-defaults) — model config keys
|
||||
- [Model failover](/concepts/model-failover) — fallback chains and retry behavior
|
||||
- [Configuration reference](/gateway/config-agents#agent-defaults) — model config keys
|
||||
- [Providers](/providers) — per-provider setup guides
|
||||
|
||||
@@ -171,8 +171,8 @@ How to see what profile IDs exist:
|
||||
|
||||
Related docs:
|
||||
|
||||
- [/concepts/model-failover](/concepts/model-failover) (rotation + cooldown rules)
|
||||
- [/tools/slash-commands](/tools/slash-commands) (command surface)
|
||||
- [Model failover](/concepts/model-failover) (rotation + cooldown rules)
|
||||
- [Slash commands](/tools/slash-commands) (command surface)
|
||||
|
||||
## Related
|
||||
|
||||
|
||||
@@ -55,9 +55,9 @@ Fix options:
|
||||
|
||||
Related:
|
||||
|
||||
- [/providers/anthropic](/providers/anthropic)
|
||||
- [/reference/token-use](/reference/token-use)
|
||||
- [/help/faq-first-run#why-am-i-seeing-http-429-ratelimiterror-from-anthropic](/help/faq-first-run#why-am-i-seeing-http-429-ratelimiterror-from-anthropic)
|
||||
- [Anthropic](/providers/anthropic)
|
||||
- [Token use and costs](/reference/token-use)
|
||||
- [Why am I seeing HTTP 429 from Anthropic?](/help/faq-first-run#why-am-i-seeing-http-429-ratelimiterror-from-anthropic)
|
||||
|
||||
## Local OpenAI-compatible backend passes direct probes but agent runs fail
|
||||
|
||||
@@ -110,9 +110,9 @@ Fix options:
|
||||
|
||||
Related:
|
||||
|
||||
- [/gateway/local-models](/gateway/local-models)
|
||||
- [/gateway/configuration](/gateway/configuration)
|
||||
- [/gateway/configuration-reference#openai-compatible-endpoints](/gateway/configuration-reference#openai-compatible-endpoints)
|
||||
- [Local models](/gateway/local-models)
|
||||
- [Configuration](/gateway/configuration)
|
||||
- [OpenAI-compatible endpoints](/gateway/configuration-reference#openai-compatible-endpoints)
|
||||
|
||||
## No replies
|
||||
|
||||
@@ -140,9 +140,9 @@ Common signatures:
|
||||
|
||||
Related:
|
||||
|
||||
- [/channels/troubleshooting](/channels/troubleshooting)
|
||||
- [/channels/pairing](/channels/pairing)
|
||||
- [/channels/groups](/channels/groups)
|
||||
- [Channel troubleshooting](/channels/troubleshooting)
|
||||
- [Pairing](/channels/pairing)
|
||||
- [Groups](/channels/groups)
|
||||
|
||||
## Dashboard control ui connectivity
|
||||
|
||||
@@ -223,11 +223,11 @@ If `openclaw devices rotate` / `revoke` / `remove` is denied unexpectedly:
|
||||
|
||||
Related:
|
||||
|
||||
- [/web/control-ui](/web/control-ui)
|
||||
- [/gateway/configuration](/gateway/configuration) (gateway auth modes)
|
||||
- [/gateway/trusted-proxy-auth](/gateway/trusted-proxy-auth)
|
||||
- [/gateway/remote](/gateway/remote)
|
||||
- [/cli/devices](/cli/devices)
|
||||
- [Control UI](/web/control-ui)
|
||||
- [Configuration](/gateway/configuration) (gateway auth modes)
|
||||
- [Trusted proxy auth](/gateway/trusted-proxy-auth)
|
||||
- [Remote access](/gateway/remote)
|
||||
- [Devices](/cli/devices)
|
||||
|
||||
## Gateway service not running
|
||||
|
||||
@@ -258,9 +258,9 @@ Common signatures:
|
||||
|
||||
Related:
|
||||
|
||||
- [/gateway/background-process](/gateway/background-process)
|
||||
- [/gateway/configuration](/gateway/configuration)
|
||||
- [/gateway/doctor](/gateway/doctor)
|
||||
- [Background exec and process tool](/gateway/background-process)
|
||||
- [Configuration](/gateway/configuration)
|
||||
- [Doctor](/gateway/doctor)
|
||||
|
||||
## Gateway restored last-known-good config
|
||||
|
||||
@@ -318,10 +318,10 @@ Fix options:
|
||||
|
||||
Related:
|
||||
|
||||
- [/gateway/configuration#strict-validation](/gateway/configuration#strict-validation)
|
||||
- [/gateway/configuration#config-hot-reload](/gateway/configuration#config-hot-reload)
|
||||
- [/cli/config](/cli/config)
|
||||
- [/gateway/doctor](/gateway/doctor)
|
||||
- [Configuration: strict validation](/gateway/configuration#strict-validation)
|
||||
- [Configuration: hot reload](/gateway/configuration#config-hot-reload)
|
||||
- [Config](/cli/config)
|
||||
- [Doctor](/gateway/doctor)
|
||||
|
||||
## Gateway probe warnings
|
||||
|
||||
@@ -348,9 +348,9 @@ Common signatures:
|
||||
|
||||
Related:
|
||||
|
||||
- [/cli/gateway](/cli/gateway)
|
||||
- [/gateway#multiple-gateways-same-host](/gateway#multiple-gateways-same-host)
|
||||
- [/gateway/remote](/gateway/remote)
|
||||
- [Gateway](/cli/gateway)
|
||||
- [Multiple gateways on the same host](/gateway#multiple-gateways-same-host)
|
||||
- [Remote access](/gateway/remote)
|
||||
|
||||
## Channel connected messages not flowing
|
||||
|
||||
@@ -378,10 +378,10 @@ Common signatures:
|
||||
|
||||
Related:
|
||||
|
||||
- [/channels/troubleshooting](/channels/troubleshooting)
|
||||
- [/channels/whatsapp](/channels/whatsapp)
|
||||
- [/channels/telegram](/channels/telegram)
|
||||
- [/channels/discord](/channels/discord)
|
||||
- [Channel troubleshooting](/channels/troubleshooting)
|
||||
- [WhatsApp](/channels/whatsapp)
|
||||
- [Telegram](/channels/telegram)
|
||||
- [Discord](/channels/discord)
|
||||
|
||||
## Cron and heartbeat delivery
|
||||
|
||||
@@ -413,9 +413,9 @@ Common signatures:
|
||||
|
||||
Related:
|
||||
|
||||
- [/automation/cron-jobs#troubleshooting](/automation/cron-jobs#troubleshooting)
|
||||
- [/automation/cron-jobs](/automation/cron-jobs)
|
||||
- [/gateway/heartbeat](/gateway/heartbeat)
|
||||
- [Scheduled tasks: troubleshooting](/automation/cron-jobs#troubleshooting)
|
||||
- [Scheduled tasks](/automation/cron-jobs)
|
||||
- [Heartbeat](/gateway/heartbeat)
|
||||
|
||||
## Node paired tool fails
|
||||
|
||||
@@ -444,9 +444,9 @@ Common signatures:
|
||||
|
||||
Related:
|
||||
|
||||
- [/nodes/troubleshooting](/nodes/troubleshooting)
|
||||
- [/nodes/index](/nodes/index)
|
||||
- [/tools/exec-approvals](/tools/exec-approvals)
|
||||
- [Node troubleshooting](/nodes/troubleshooting)
|
||||
- [Nodes](/nodes/index)
|
||||
- [Exec approvals](/tools/exec-approvals)
|
||||
|
||||
## Browser tool fails
|
||||
|
||||
@@ -492,8 +492,8 @@ Common signatures:
|
||||
|
||||
Related:
|
||||
|
||||
- [/tools/browser-linux-troubleshooting](/tools/browser-linux-troubleshooting)
|
||||
- [/tools/browser](/tools/browser)
|
||||
- [Browser troubleshooting](/tools/browser-linux-troubleshooting)
|
||||
- [Browser (OpenClaw-managed)](/tools/browser)
|
||||
|
||||
## If you upgraded and something suddenly broke
|
||||
|
||||
@@ -566,9 +566,9 @@ openclaw gateway restart
|
||||
|
||||
Related:
|
||||
|
||||
- [/gateway/pairing](/gateway/pairing)
|
||||
- [/gateway/authentication](/gateway/authentication)
|
||||
- [/gateway/background-process](/gateway/background-process)
|
||||
- [Gateway-owned pairing](/gateway/pairing)
|
||||
- [Authentication](/gateway/authentication)
|
||||
- [Background exec and process tool](/gateway/background-process)
|
||||
|
||||
## Related
|
||||
|
||||
|
||||
@@ -693,11 +693,11 @@ turn for that agent must be a Codex-supported OpenAI model.
|
||||
|
||||
## Related
|
||||
|
||||
- [Agent Harness Plugins](/plugins/sdk-agent-harness)
|
||||
- [Agent harness plugins](/plugins/sdk-agent-harness)
|
||||
- [Agent runtimes](/concepts/agent-runtimes)
|
||||
- [Model Providers](/concepts/model-providers)
|
||||
- [Model providers](/concepts/model-providers)
|
||||
- [OpenAI provider](/providers/openai)
|
||||
- [Status](/cli/status)
|
||||
- [Plugin hooks](/plugins/hooks)
|
||||
- [Configuration Reference](/gateway/configuration-reference)
|
||||
- [Configuration reference](/gateway/configuration-reference)
|
||||
- [Testing](/help/testing-live#live-codex-app-server-harness-smoke)
|
||||
|
||||
@@ -158,7 +158,7 @@ the microphone/speaker path used by OpenClaw. For clean duplex audio, use
|
||||
separate virtual devices or a Loopback-style graph; a single BlackHole device is
|
||||
enough for a first smoke test but can echo.
|
||||
|
||||
### Local Gateway + Parallels Chrome
|
||||
### Local gateway + Parallels Chrome
|
||||
|
||||
You do **not** need a full OpenClaw Gateway or model API key inside a macOS VM
|
||||
just to make the VM own Chrome. Run the Gateway and agent locally, then run a
|
||||
|
||||
@@ -462,6 +462,6 @@ Beyond `api.runtime`, the API object also provides:
|
||||
|
||||
## Related
|
||||
|
||||
- [SDK Overview](/plugins/sdk-overview) -- subpath reference
|
||||
- [SDK Entry Points](/plugins/sdk-entrypoints) -- `definePluginEntry` options
|
||||
- [Plugin Internals](/plugins/architecture) -- capability model and registry
|
||||
- [SDK overview](/plugins/sdk-overview) — subpath reference
|
||||
- [SDK entry points](/plugins/sdk-entrypoints) — `definePluginEntry` options
|
||||
- [Plugin internals](/plugins/architecture) — capability model and registry
|
||||
|
||||
@@ -566,6 +566,6 @@ startup installs; keep using the explicit plugin installer.
|
||||
|
||||
## Related
|
||||
|
||||
- [SDK Entry Points](/plugins/sdk-entrypoints) -- `definePluginEntry` and `defineChannelPluginEntry`
|
||||
- [Plugin Manifest](/plugins/manifest) -- full manifest schema reference
|
||||
- [Building Plugins](/plugins/building-plugins) -- step-by-step getting started guide
|
||||
- [SDK entry points](/plugins/sdk-entrypoints) — `definePluginEntry` and `defineChannelPluginEntry`
|
||||
- [Plugin manifest](/plugins/manifest) — full manifest schema reference
|
||||
- [Building plugins](/plugins/building-plugins) — step-by-step getting started guide
|
||||
|
||||
@@ -338,9 +338,9 @@ Defaults:
|
||||
Related docs:
|
||||
|
||||
- [Anthropic](/providers/anthropic)
|
||||
- [Token Use and Costs](/reference/token-use)
|
||||
- [Session Pruning](/concepts/session-pruning)
|
||||
- [Gateway Configuration Reference](/gateway/configuration-reference)
|
||||
- [Token use and costs](/reference/token-use)
|
||||
- [Session pruning](/concepts/session-pruning)
|
||||
- [Gateway configuration reference](/gateway/configuration-reference)
|
||||
|
||||
## Related
|
||||
|
||||
|
||||
@@ -39,7 +39,7 @@ Rules:
|
||||
- The web UI strips the shortcode from visible text and renders the embed inline.
|
||||
- `MEDIA:` is not an embed alias and should not be used for rich embed rendering.
|
||||
|
||||
## Stored Rendering Shape
|
||||
## Stored rendering shape
|
||||
|
||||
The normalized/stored assistant content block is a structured `canvas` item:
|
||||
|
||||
|
||||
@@ -21,12 +21,12 @@ This document explains how OpenClaw manages sessions end-to-end:
|
||||
|
||||
If you want a higher-level overview first, start with:
|
||||
|
||||
- [/concepts/session](/concepts/session)
|
||||
- [/concepts/compaction](/concepts/compaction)
|
||||
- [/concepts/memory](/concepts/memory)
|
||||
- [/concepts/memory-search](/concepts/memory-search)
|
||||
- [/concepts/session-pruning](/concepts/session-pruning)
|
||||
- [/reference/transcript-hygiene](/reference/transcript-hygiene)
|
||||
- [Session management](/concepts/session)
|
||||
- [Compaction](/concepts/compaction)
|
||||
- [Memory overview](/concepts/memory)
|
||||
- [Memory search](/concepts/memory-search)
|
||||
- [Session pruning](/concepts/session-pruning)
|
||||
- [Transcript hygiene](/reference/transcript-hygiene)
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -27,7 +27,7 @@ Scope includes:
|
||||
|
||||
If you need transcript storage details, see:
|
||||
|
||||
- [/reference/session-management-compaction](/reference/session-management-compaction)
|
||||
- [Session management deep dive](/reference/session-management-compaction)
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -427,7 +427,7 @@ Defaults:
|
||||
|
||||
All control endpoints accept `?profile=<name>`; the CLI uses `--browser-profile`.
|
||||
|
||||
## Existing-session via Chrome DevTools MCP
|
||||
## Existing session via Chrome DevTools MCP
|
||||
|
||||
OpenClaw can also attach to a running Chromium-based browser profile through the
|
||||
official Chrome DevTools MCP server. This reuses the tabs and login state
|
||||
|
||||
@@ -423,13 +423,13 @@ observe results through `after_tool_call`, and participate in Codex
|
||||
arguments yet. The exact Codex runtime support boundary lives in the
|
||||
[Codex harness v1 support contract](/plugins/codex-harness#v1-support-contract).
|
||||
|
||||
For full typed hook behavior, see [SDK Overview](/plugins/sdk-overview#hook-decision-semantics).
|
||||
For full typed hook behavior, see [SDK overview](/plugins/sdk-overview#hook-decision-semantics).
|
||||
|
||||
## Related
|
||||
|
||||
- [Building Plugins](/plugins/building-plugins) — create your own plugin
|
||||
- [Plugin Bundles](/plugins/bundles) — Codex/Claude/Cursor bundle compatibility
|
||||
- [Plugin Manifest](/plugins/manifest) — manifest schema
|
||||
- [Registering Tools](/plugins/building-plugins#registering-agent-tools) — add agent tools in a plugin
|
||||
- [Plugin Internals](/plugins/architecture) — capability model and load pipeline
|
||||
- [Community Plugins](/plugins/community) — third-party listings
|
||||
- [Building plugins](/plugins/building-plugins) — create your own plugin
|
||||
- [Plugin bundles](/plugins/bundles) — Codex/Claude/Cursor bundle compatibility
|
||||
- [Plugin manifest](/plugins/manifest) — manifest schema
|
||||
- [Registering tools](/plugins/building-plugins#registering-agent-tools) — add agent tools in a plugin
|
||||
- [Plugin internals](/plugins/architecture) — capability model and load pipeline
|
||||
- [Community plugins](/plugins/community) — third-party listings
|
||||
|
||||
@@ -170,7 +170,7 @@ Auto-archive:
|
||||
- Auto-archive applies equally to depth-1 and depth-2 sessions.
|
||||
- Browser cleanup is separate from archive cleanup: tracked browser tabs/processes are best-effort closed when the run finishes, even if the transcript/session record is kept.
|
||||
|
||||
## Nested Sub-Agents
|
||||
## Nested sub-agents
|
||||
|
||||
By default, sub-agents cannot spawn their own sub-agents (`maxSpawnDepth: 1`). You can enable one level of nesting by setting `maxSpawnDepth: 2`, which allows the **orchestrator pattern**: main → orchestrator sub-agent → worker sub-sub-agents.
|
||||
|
||||
|
||||
@@ -318,7 +318,7 @@ Trusted-proxy note:
|
||||
device identity
|
||||
- this does **not** extend to node-role Control UI sessions
|
||||
- same-host loopback reverse proxies still do not satisfy trusted-proxy auth; see
|
||||
[Trusted Proxy Auth](/gateway/trusted-proxy-auth)
|
||||
[Trusted proxy auth](/gateway/trusted-proxy-auth)
|
||||
|
||||
See [Tailscale](/gateway/tailscale) for HTTPS setup guidance.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user