From c5c163d07883f418c8dd020d12ddb09639168c83 Mon Sep 17 00:00:00 2001 From: Vincent Koc Date: Thu, 23 Apr 2026 13:18:10 -0700 Subject: [PATCH] docs: standardize frontmatter field order (summary before title) --- docs/auth-credential-semantics.md | 2 +- docs/channels/irc.md | 2 +- docs/channels/qa-channel.md | 2 +- docs/ci.md | 2 +- docs/cli/sandbox.md | 2 +- docs/concepts/active-memory.md | 2 +- docs/concepts/dreaming.md | 2 +- docs/concepts/experimental-features.md | 2 +- docs/concepts/memory-builtin.md | 2 +- docs/concepts/memory-honcho.md | 2 +- docs/concepts/memory-qmd.md | 2 +- docs/concepts/memory-search.md | 2 +- docs/concepts/memory.md | 2 +- docs/concepts/session-pruning.md | 2 +- docs/gateway/configuration-reference.md | 2 +- docs/gateway/diagnostics.md | 2 +- docs/gateway/openshell.md | 2 +- docs/gateway/sandbox-vs-tool-policy-vs-elevated.md | 2 +- docs/gateway/trusted-proxy-auth.md | 2 +- docs/help/gpt54-codex-agentic-parity-maintainers.md | 2 +- docs/help/gpt54-codex-agentic-parity.md | 2 +- docs/install/fly.md | 2 +- docs/install/node.md | 2 +- docs/pi-dev.md | 2 +- docs/pi.md | 2 +- docs/plan/ui-channels.md | 2 +- docs/plugins/building-extensions.md | 2 +- docs/plugins/building-plugins.md | 2 +- docs/plugins/codex-harness.md | 2 +- docs/plugins/message-presentation.md | 2 +- docs/plugins/sdk-agent-harness.md | 2 +- docs/plugins/sdk-channel-plugins.md | 2 +- docs/plugins/sdk-entrypoints.md | 2 +- docs/plugins/sdk-migration.md | 2 +- docs/plugins/sdk-overview.md | 2 +- docs/plugins/sdk-provider-plugins.md | 2 +- docs/plugins/sdk-runtime.md | 2 +- docs/plugins/sdk-setup.md | 2 +- docs/plugins/sdk-testing.md | 2 +- docs/plugins/skill-workshop.md | 2 +- docs/providers/alibaba.md | 2 +- docs/providers/arcee.md | 2 +- docs/providers/chutes.md | 2 +- docs/providers/cloudflare-ai-gateway.md | 2 +- docs/providers/comfy.md | 2 +- docs/providers/deepseek.md | 2 +- docs/providers/fal.md | 2 +- docs/providers/fireworks.md | 2 +- docs/providers/google.md | 2 +- docs/providers/groq.md | 2 +- docs/providers/kilocode.md | 2 +- docs/providers/litellm.md | 2 +- docs/providers/perplexity-provider.md | 2 +- docs/providers/qwen_modelstudio.md | 2 +- docs/providers/runway.md | 2 +- docs/providers/tencent.md | 2 +- docs/providers/together.md | 2 +- docs/providers/vercel-ai-gateway.md | 2 +- docs/providers/volcengine.md | 2 +- docs/reference/AGENTS.default.md | 2 +- docs/reference/RELEASING.md | 2 +- docs/reference/memory-config.md | 2 +- docs/reference/prompt-caching.md | 2 +- docs/reference/templates/AGENTS.dev.md | 2 +- docs/reference/templates/AGENTS.md | 2 +- docs/reference/templates/BOOT.md | 2 +- docs/reference/templates/BOOTSTRAP.md | 2 +- docs/reference/templates/HEARTBEAT.md | 2 +- docs/reference/templates/IDENTITY.dev.md | 2 +- docs/reference/templates/IDENTITY.md | 2 +- docs/reference/templates/SOUL.dev.md | 2 +- docs/reference/templates/SOUL.md | 2 +- docs/reference/templates/TOOLS.dev.md | 2 +- docs/reference/templates/TOOLS.md | 2 +- docs/reference/templates/USER.dev.md | 2 +- docs/reference/templates/USER.md | 2 +- docs/security/CONTRIBUTING-THREAT-MODEL.md | 2 +- docs/security/THREAT-MODEL-ATLAS.md | 2 +- docs/security/formal-verification.md | 2 +- docs/start/showcase.md | 2 +- docs/tools/creating-skills.md | 2 +- docs/tools/diffs.md | 2 +- docs/tools/lobster.md | 2 +- docs/tools/loop-detection.md | 2 +- docs/tools/pdf.md | 2 +- docs/tools/tokenjuice.md | 2 +- docs/tools/web.md | 2 +- docs/tts.md | 2 +- 88 files changed, 88 insertions(+), 88 deletions(-) diff --git a/docs/auth-credential-semantics.md b/docs/auth-credential-semantics.md index 4db91971baa..7c9406e274f 100644 --- a/docs/auth-credential-semantics.md +++ b/docs/auth-credential-semantics.md @@ -1,6 +1,6 @@ --- -title: "Auth credential semantics" summary: "Canonical credential eligibility and resolution semantics for auth profiles" +title: "Auth credential semantics" read_when: - Working on auth profile resolution or credential routing - Debugging model auth failures or profile order diff --git a/docs/channels/irc.md b/docs/channels/irc.md index cb7aedbe4d0..bc3b5cd7c7b 100644 --- a/docs/channels/irc.md +++ b/docs/channels/irc.md @@ -1,6 +1,6 @@ --- -title: IRC summary: "IRC plugin setup, access controls, and troubleshooting" +title: IRC read_when: - You want to connect OpenClaw to IRC channels or DMs - You are configuring IRC allowlists, group policy, or mention gating diff --git a/docs/channels/qa-channel.md b/docs/channels/qa-channel.md index 74d2347c33c..2e7ec1950bb 100644 --- a/docs/channels/qa-channel.md +++ b/docs/channels/qa-channel.md @@ -1,6 +1,6 @@ --- -title: "QA channel" summary: "Synthetic Slack-class channel plugin for deterministic OpenClaw QA scenarios" +title: "QA channel" read_when: - You are wiring the synthetic QA transport into a local or CI test run - You need the bundled qa-channel config surface diff --git a/docs/ci.md b/docs/ci.md index 9d2dbabeb90..8de995cbcfa 100644 --- a/docs/ci.md +++ b/docs/ci.md @@ -1,6 +1,6 @@ --- -title: CI pipeline summary: "CI job graph, scope gates, and local command equivalents" +title: CI pipeline read_when: - You need to understand why a CI job did or did not run - You are debugging failing GitHub Actions checks diff --git a/docs/cli/sandbox.md b/docs/cli/sandbox.md index 4c310489c02..a183692bc41 100644 --- a/docs/cli/sandbox.md +++ b/docs/cli/sandbox.md @@ -1,6 +1,6 @@ --- -title: Sandbox CLI summary: "Manage sandbox runtimes and inspect effective sandbox policy" +title: Sandbox CLI read_when: "You are managing sandbox runtimes or debugging sandbox/tool-policy behavior." status: active --- diff --git a/docs/concepts/active-memory.md b/docs/concepts/active-memory.md index 611114e8b59..72a733647b9 100644 --- a/docs/concepts/active-memory.md +++ b/docs/concepts/active-memory.md @@ -1,6 +1,6 @@ --- -title: "Active memory" summary: "A plugin-owned blocking memory sub-agent that injects relevant memory into interactive chat sessions" +title: "Active memory" read_when: - You want to understand what active memory is for - You want to turn active memory on for a conversational agent diff --git a/docs/concepts/dreaming.md b/docs/concepts/dreaming.md index e2f1a2ad263..e2687c46518 100644 --- a/docs/concepts/dreaming.md +++ b/docs/concepts/dreaming.md @@ -1,6 +1,6 @@ --- -title: "Dreaming" summary: "Background memory consolidation with light, deep, and REM phases plus a Dream Diary" +title: "Dreaming" read_when: - You want memory promotion to run automatically - You want to understand what each dreaming phase does diff --git a/docs/concepts/experimental-features.md b/docs/concepts/experimental-features.md index 5547d85beb3..dc9452f1b95 100644 --- a/docs/concepts/experimental-features.md +++ b/docs/concepts/experimental-features.md @@ -1,6 +1,6 @@ --- -title: "Experimental features" summary: "What experimental flags mean in OpenClaw and which ones are currently documented" +title: "Experimental features" read_when: - You see an `.experimental` config key and want to know whether it is stable - You want to try preview runtime features without confusing them with normal defaults diff --git a/docs/concepts/memory-builtin.md b/docs/concepts/memory-builtin.md index a1e7e085249..7c3c52e4a64 100644 --- a/docs/concepts/memory-builtin.md +++ b/docs/concepts/memory-builtin.md @@ -1,6 +1,6 @@ --- -title: "Builtin memory engine" summary: "The default SQLite-based memory backend with keyword, vector, and hybrid search" +title: "Builtin memory engine" read_when: - You want to understand the default memory backend - You want to configure embedding providers or hybrid search diff --git a/docs/concepts/memory-honcho.md b/docs/concepts/memory-honcho.md index cb8f886de35..bbb4fc34d1a 100644 --- a/docs/concepts/memory-honcho.md +++ b/docs/concepts/memory-honcho.md @@ -1,6 +1,6 @@ --- -title: "Honcho memory" summary: "AI-native cross-session memory via the Honcho plugin" +title: "Honcho memory" read_when: - You want persistent memory that works across sessions and channels - You want AI-powered recall and user modeling diff --git a/docs/concepts/memory-qmd.md b/docs/concepts/memory-qmd.md index d465cc6a20e..6047e1ec029 100644 --- a/docs/concepts/memory-qmd.md +++ b/docs/concepts/memory-qmd.md @@ -1,6 +1,6 @@ --- -title: "QMD memory engine" summary: "Local-first search sidecar with BM25, vectors, reranking, and query expansion" +title: "QMD memory engine" read_when: - You want to set up QMD as your memory backend - You want advanced memory features like reranking or extra indexed paths diff --git a/docs/concepts/memory-search.md b/docs/concepts/memory-search.md index f43b8906d2f..4e43015613b 100644 --- a/docs/concepts/memory-search.md +++ b/docs/concepts/memory-search.md @@ -1,6 +1,6 @@ --- -title: "Memory search" summary: "How memory search finds relevant notes using embeddings and hybrid retrieval" +title: "Memory search" read_when: - You want to understand how memory_search works - You want to choose an embedding provider diff --git a/docs/concepts/memory.md b/docs/concepts/memory.md index 9b5a0aaaaa5..c9405c85a75 100644 --- a/docs/concepts/memory.md +++ b/docs/concepts/memory.md @@ -1,6 +1,6 @@ --- -title: "Memory overview" summary: "How OpenClaw remembers things across sessions" +title: "Memory overview" read_when: - You want to understand how memory works - You want to know what memory files to write diff --git a/docs/concepts/session-pruning.md b/docs/concepts/session-pruning.md index 6fec6fe00d4..d834fe37bba 100644 --- a/docs/concepts/session-pruning.md +++ b/docs/concepts/session-pruning.md @@ -1,6 +1,6 @@ --- -title: "Session pruning" summary: "Trimming old tool results to keep context lean and caching efficient" +title: "Session pruning" read_when: - You want to reduce context growth from tool outputs - You want to understand Anthropic prompt cache optimization diff --git a/docs/gateway/configuration-reference.md b/docs/gateway/configuration-reference.md index 24e0baa74cc..5da6770f190 100644 --- a/docs/gateway/configuration-reference.md +++ b/docs/gateway/configuration-reference.md @@ -1,6 +1,6 @@ --- -title: "Configuration reference" summary: "Gateway config reference for core OpenClaw keys, defaults, and links to dedicated subsystem references" +title: "Configuration reference" read_when: - You need exact field-level config semantics or defaults - You are validating channel, model, gateway, or tool config blocks diff --git a/docs/gateway/diagnostics.md b/docs/gateway/diagnostics.md index 04227a5b1b5..54b05ff9760 100644 --- a/docs/gateway/diagnostics.md +++ b/docs/gateway/diagnostics.md @@ -1,6 +1,6 @@ --- -title: "Diagnostics export" summary: "Create shareable Gateway diagnostics bundles for bug reports" +title: "Diagnostics export" read_when: - Preparing a bug report or support request - Debugging Gateway crashes, restarts, memory pressure, or oversized payloads diff --git a/docs/gateway/openshell.md b/docs/gateway/openshell.md index 6935595511e..358c882c198 100644 --- a/docs/gateway/openshell.md +++ b/docs/gateway/openshell.md @@ -1,6 +1,6 @@ --- -title: OpenShell summary: "Use OpenShell as a managed sandbox backend for OpenClaw agents" +title: OpenShell read_when: - You want cloud-managed sandboxes instead of local Docker - You are setting up the OpenShell plugin diff --git a/docs/gateway/sandbox-vs-tool-policy-vs-elevated.md b/docs/gateway/sandbox-vs-tool-policy-vs-elevated.md index 1bad5d09031..b57bb6f2b51 100644 --- a/docs/gateway/sandbox-vs-tool-policy-vs-elevated.md +++ b/docs/gateway/sandbox-vs-tool-policy-vs-elevated.md @@ -1,6 +1,6 @@ --- -title: Sandbox vs tool policy vs elevated summary: "Why a tool is blocked: sandbox runtime, tool allow/deny policy, and elevated exec gates" +title: Sandbox vs tool policy vs elevated read_when: "You hit 'sandbox jail' or see a tool/elevated refusal and want the exact config key to change." status: active --- diff --git a/docs/gateway/trusted-proxy-auth.md b/docs/gateway/trusted-proxy-auth.md index 3dc6c3cdc19..fb9f00b9df6 100644 --- a/docs/gateway/trusted-proxy-auth.md +++ b/docs/gateway/trusted-proxy-auth.md @@ -1,6 +1,6 @@ --- -title: "Trusted proxy auth" summary: "Delegate gateway authentication to a trusted reverse proxy (Pomerium, Caddy, nginx + OAuth)" +title: "Trusted proxy auth" read_when: - Running OpenClaw behind an identity-aware proxy - Setting up Pomerium, Caddy, or nginx with OAuth in front of OpenClaw diff --git a/docs/help/gpt54-codex-agentic-parity-maintainers.md b/docs/help/gpt54-codex-agentic-parity-maintainers.md index 199fd73e287..81506b8e191 100644 --- a/docs/help/gpt54-codex-agentic-parity-maintainers.md +++ b/docs/help/gpt54-codex-agentic-parity-maintainers.md @@ -1,6 +1,6 @@ --- -title: "GPT-5.4 / Codex parity maintainer notes" summary: "How to review the GPT-5.4 / Codex parity program as four merge units" +title: "GPT-5.4 / Codex parity maintainer notes" read_when: - Reviewing the GPT-5.4 / Codex parity PR series - Maintaining the six-contract agentic architecture behind the parity program diff --git a/docs/help/gpt54-codex-agentic-parity.md b/docs/help/gpt54-codex-agentic-parity.md index 33bd9d17fbe..3f134c358b5 100644 --- a/docs/help/gpt54-codex-agentic-parity.md +++ b/docs/help/gpt54-codex-agentic-parity.md @@ -1,6 +1,6 @@ --- -title: "GPT-5.4 / Codex agentic parity" summary: "How OpenClaw closes agentic execution gaps for GPT-5.4 and Codex-style models" +title: "GPT-5.4 / Codex agentic parity" read_when: - Debugging GPT-5.4 or Codex agent behavior - Comparing OpenClaw agentic behavior across frontier models diff --git a/docs/install/fly.md b/docs/install/fly.md index 2acb7d353c4..a5c75817159 100644 --- a/docs/install/fly.md +++ b/docs/install/fly.md @@ -1,6 +1,6 @@ --- -title: Fly.io summary: "Step-by-step Fly.io deployment for OpenClaw with persistent storage and HTTPS" +title: Fly.io read_when: - Deploying OpenClaw on Fly.io - Setting up Fly volumes, secrets, and first-run config diff --git a/docs/install/node.md b/docs/install/node.md index de559bc0921..cc78a496c82 100644 --- a/docs/install/node.md +++ b/docs/install/node.md @@ -1,6 +1,6 @@ --- -title: "Node.js" summary: "Install and configure Node.js for OpenClaw — version requirements, install options, and PATH troubleshooting" +title: "Node.js" read_when: - "You need to install Node.js before installing OpenClaw" - "You installed OpenClaw but `openclaw` is command not found" diff --git a/docs/pi-dev.md b/docs/pi-dev.md index 1c359b8a4fd..40f8efc26a1 100644 --- a/docs/pi-dev.md +++ b/docs/pi-dev.md @@ -1,6 +1,6 @@ --- -title: "Pi development workflow" summary: "Developer workflow for Pi integration: build, test, and live validation" +title: "Pi development workflow" read_when: - Working on Pi integration code or tests - Running Pi-specific lint, typecheck, and live test flows diff --git a/docs/pi.md b/docs/pi.md index d054c190196..6e00a961001 100644 --- a/docs/pi.md +++ b/docs/pi.md @@ -1,6 +1,6 @@ --- -title: "Pi integration architecture" summary: "Architecture of OpenClaw's embedded Pi agent integration and session lifecycle" +title: "Pi integration architecture" read_when: - Understanding Pi SDK integration design in OpenClaw - Modifying agent session lifecycle, tooling, or provider wiring for Pi diff --git a/docs/plan/ui-channels.md b/docs/plan/ui-channels.md index 3fc1e886160..7abf02e80cf 100644 --- a/docs/plan/ui-channels.md +++ b/docs/plan/ui-channels.md @@ -1,6 +1,6 @@ --- -title: Channel presentation refactor plan summary: Decouple semantic message presentation from channel native UI renderers. +title: Channel presentation refactor plan read_when: - Refactoring channel message UI, interactive payloads, or native channel renderers - Changing message tool capabilities, delivery hints, or cross-context markers diff --git a/docs/plugins/building-extensions.md b/docs/plugins/building-extensions.md index c9a7d49a24c..0514de3e480 100644 --- a/docs/plugins/building-extensions.md +++ b/docs/plugins/building-extensions.md @@ -1,6 +1,6 @@ --- -title: "Building plugins (redirect)" summary: "Redirects to the current Building Plugins guide" +title: "Building plugins (redirect)" read_when: - Legacy link to building-extensions --- diff --git a/docs/plugins/building-plugins.md b/docs/plugins/building-plugins.md index 8ef0dc85a6a..cbe48e62019 100644 --- a/docs/plugins/building-plugins.md +++ b/docs/plugins/building-plugins.md @@ -1,7 +1,7 @@ --- +summary: "Create your first OpenClaw plugin in minutes" title: "Building plugins" sidebarTitle: "Getting Started" -summary: "Create your first OpenClaw plugin in minutes" read_when: - You want to create a new OpenClaw plugin - You need a quick-start for plugin development diff --git a/docs/plugins/codex-harness.md b/docs/plugins/codex-harness.md index 4362d759fc0..b96c9798ca5 100644 --- a/docs/plugins/codex-harness.md +++ b/docs/plugins/codex-harness.md @@ -1,6 +1,6 @@ --- -title: "Codex harness" summary: "Run OpenClaw embedded agent turns through the bundled Codex app-server harness" +title: "Codex harness" read_when: - You want to use the bundled Codex app-server harness - You need Codex model refs and config examples diff --git a/docs/plugins/message-presentation.md b/docs/plugins/message-presentation.md index 96481450469..a45aa28fb1d 100644 --- a/docs/plugins/message-presentation.md +++ b/docs/plugins/message-presentation.md @@ -1,6 +1,6 @@ --- -title: "Message presentation" summary: "Semantic message cards, buttons, selects, fallback text, and delivery hints for channel plugins" +title: "Message presentation" read_when: - Adding or modifying message card, button, or select rendering - Building a channel plugin that supports rich outbound messages diff --git a/docs/plugins/sdk-agent-harness.md b/docs/plugins/sdk-agent-harness.md index 103df5ffe6b..059d0e67090 100644 --- a/docs/plugins/sdk-agent-harness.md +++ b/docs/plugins/sdk-agent-harness.md @@ -1,7 +1,7 @@ --- +summary: "Experimental SDK surface for plugins that replace the low level embedded agent executor" title: "Agent harness plugins" sidebarTitle: "Agent Harness" -summary: "Experimental SDK surface for plugins that replace the low level embedded agent executor" read_when: - You are changing the embedded agent runtime or harness registry - You are registering an agent harness from a bundled or trusted plugin diff --git a/docs/plugins/sdk-channel-plugins.md b/docs/plugins/sdk-channel-plugins.md index f7b463a6ecd..d6a04edc17c 100644 --- a/docs/plugins/sdk-channel-plugins.md +++ b/docs/plugins/sdk-channel-plugins.md @@ -1,7 +1,7 @@ --- +summary: "Step-by-step guide to building a messaging channel plugin for OpenClaw" title: "Building channel plugins" sidebarTitle: "Channel Plugins" -summary: "Step-by-step guide to building a messaging channel plugin for OpenClaw" read_when: - You are building a new messaging channel plugin - You want to connect OpenClaw to a messaging platform diff --git a/docs/plugins/sdk-entrypoints.md b/docs/plugins/sdk-entrypoints.md index c88c6fe8075..3da9fded23d 100644 --- a/docs/plugins/sdk-entrypoints.md +++ b/docs/plugins/sdk-entrypoints.md @@ -1,7 +1,7 @@ --- +summary: "Reference for definePluginEntry, defineChannelPluginEntry, and defineSetupPluginEntry" title: "Plugin entry points" sidebarTitle: "Entry Points" -summary: "Reference for definePluginEntry, defineChannelPluginEntry, and defineSetupPluginEntry" read_when: - You need the exact type signature of definePluginEntry or defineChannelPluginEntry - You want to understand registration mode (full vs setup vs CLI metadata) diff --git a/docs/plugins/sdk-migration.md b/docs/plugins/sdk-migration.md index 865311c94c5..a72d6d8f724 100644 --- a/docs/plugins/sdk-migration.md +++ b/docs/plugins/sdk-migration.md @@ -1,7 +1,7 @@ --- +summary: "Migrate from the legacy backwards-compatibility layer to the modern plugin SDK" title: "Plugin SDK migration" sidebarTitle: "Migrate to SDK" -summary: "Migrate from the legacy backwards-compatibility layer to the modern plugin SDK" read_when: - You see the OPENCLAW_PLUGIN_SDK_COMPAT_DEPRECATED warning - You see the OPENCLAW_EXTENSION_API_DEPRECATED warning diff --git a/docs/plugins/sdk-overview.md b/docs/plugins/sdk-overview.md index 981e73ecba9..09aa754a33f 100644 --- a/docs/plugins/sdk-overview.md +++ b/docs/plugins/sdk-overview.md @@ -1,7 +1,7 @@ --- +summary: "Import map, registration API reference, and SDK architecture" title: "Plugin SDK overview" sidebarTitle: "SDK overview" -summary: "Import map, registration API reference, and SDK architecture" read_when: - You need to know which SDK subpath to import from - You want a reference for all registration methods on OpenClawPluginApi diff --git a/docs/plugins/sdk-provider-plugins.md b/docs/plugins/sdk-provider-plugins.md index a15be311d11..bd385200512 100644 --- a/docs/plugins/sdk-provider-plugins.md +++ b/docs/plugins/sdk-provider-plugins.md @@ -1,7 +1,7 @@ --- +summary: "Step-by-step guide to building a model provider plugin for OpenClaw" title: "Building provider plugins" sidebarTitle: "Provider plugins" -summary: "Step-by-step guide to building a model provider plugin for OpenClaw" read_when: - You are building a new model provider plugin - You want to add an OpenAI-compatible proxy or custom LLM to OpenClaw diff --git a/docs/plugins/sdk-runtime.md b/docs/plugins/sdk-runtime.md index d93e768afed..fc016036b4d 100644 --- a/docs/plugins/sdk-runtime.md +++ b/docs/plugins/sdk-runtime.md @@ -1,7 +1,7 @@ --- +summary: "api.runtime -- the injected runtime helpers available to plugins" title: "Plugin runtime helpers" sidebarTitle: "Runtime Helpers" -summary: "api.runtime -- the injected runtime helpers available to plugins" read_when: - You need to call core helpers from a plugin (TTS, STT, image gen, web search, subagent) - You want to understand what api.runtime exposes diff --git a/docs/plugins/sdk-setup.md b/docs/plugins/sdk-setup.md index 6396848dd55..57d36d716b7 100644 --- a/docs/plugins/sdk-setup.md +++ b/docs/plugins/sdk-setup.md @@ -1,7 +1,7 @@ --- +summary: "Setup wizards, setup-entry.ts, config schemas, and package.json metadata" title: "Plugin setup and config" sidebarTitle: "Setup and Config" -summary: "Setup wizards, setup-entry.ts, config schemas, and package.json metadata" read_when: - You are adding a setup wizard to a plugin - You need to understand setup-entry.ts vs index.ts diff --git a/docs/plugins/sdk-testing.md b/docs/plugins/sdk-testing.md index 0eb4f24c2ad..dfd874f6a93 100644 --- a/docs/plugins/sdk-testing.md +++ b/docs/plugins/sdk-testing.md @@ -1,7 +1,7 @@ --- +summary: "Testing utilities and patterns for OpenClaw plugins" title: "Plugin testing" sidebarTitle: "Testing" -summary: "Testing utilities and patterns for OpenClaw plugins" read_when: - You are writing tests for a plugin - You need test utilities from the plugin SDK diff --git a/docs/plugins/skill-workshop.md b/docs/plugins/skill-workshop.md index 2f7fa82e402..5be1ac5a649 100644 --- a/docs/plugins/skill-workshop.md +++ b/docs/plugins/skill-workshop.md @@ -1,6 +1,6 @@ --- -title: "Skill workshop plugin" summary: "Experimental capture of reusable procedures as workspace skills with review, approval, quarantine, and hot skill refresh" +title: "Skill workshop plugin" read_when: - You want agents to turn corrections or reusable procedures into workspace skills - You are configuring procedural skill memory diff --git a/docs/providers/alibaba.md b/docs/providers/alibaba.md index aa8f3137524..75690e96390 100644 --- a/docs/providers/alibaba.md +++ b/docs/providers/alibaba.md @@ -1,6 +1,6 @@ --- -title: "Alibaba Model Studio" summary: "Alibaba Model Studio Wan video generation in OpenClaw" +title: "Alibaba Model Studio" read_when: - You want to use Alibaba Wan video generation in OpenClaw - You need Model Studio or DashScope API key setup for video generation diff --git a/docs/providers/arcee.md b/docs/providers/arcee.md index 2d9e4512d6b..90e0523cca2 100644 --- a/docs/providers/arcee.md +++ b/docs/providers/arcee.md @@ -1,6 +1,6 @@ --- -title: "Arcee AI" summary: "Arcee AI setup (auth + model selection)" +title: "Arcee AI" read_when: - You want to use Arcee AI with OpenClaw - You need the API key env var or CLI auth choice diff --git a/docs/providers/chutes.md b/docs/providers/chutes.md index ff9732a7e82..f218f902e04 100644 --- a/docs/providers/chutes.md +++ b/docs/providers/chutes.md @@ -1,6 +1,6 @@ --- -title: "Chutes" summary: "Chutes setup (OAuth or API key, model discovery, aliases)" +title: "Chutes" read_when: - You want to use Chutes with OpenClaw - You need the OAuth or API key setup path diff --git a/docs/providers/cloudflare-ai-gateway.md b/docs/providers/cloudflare-ai-gateway.md index dccfc053303..4793a437198 100644 --- a/docs/providers/cloudflare-ai-gateway.md +++ b/docs/providers/cloudflare-ai-gateway.md @@ -1,6 +1,6 @@ --- -title: "Cloudflare AI gateway" summary: "Cloudflare AI Gateway setup (auth + model selection)" +title: "Cloudflare AI gateway" read_when: - You want to use Cloudflare AI Gateway with OpenClaw - You need the account ID, gateway ID, or API key env var diff --git a/docs/providers/comfy.md b/docs/providers/comfy.md index 7cbd5df13bf..e8fd23e50c6 100644 --- a/docs/providers/comfy.md +++ b/docs/providers/comfy.md @@ -1,6 +1,6 @@ --- -title: "ComfyUI" summary: "ComfyUI workflow image, video, and music generation setup in OpenClaw" +title: "ComfyUI" read_when: - You want to use local ComfyUI workflows with OpenClaw - You want to use Comfy Cloud with image, video, or music workflows diff --git a/docs/providers/deepseek.md b/docs/providers/deepseek.md index c56bc2f0eb6..e0f27cddb79 100644 --- a/docs/providers/deepseek.md +++ b/docs/providers/deepseek.md @@ -1,6 +1,6 @@ --- -title: "DeepSeek" summary: "DeepSeek setup (auth + model selection)" +title: "DeepSeek" read_when: - You want to use DeepSeek with OpenClaw - You need the API key env var or CLI auth choice diff --git a/docs/providers/fal.md b/docs/providers/fal.md index 8c3002b978d..9bdb1c2fac7 100644 --- a/docs/providers/fal.md +++ b/docs/providers/fal.md @@ -1,6 +1,6 @@ --- -title: "Fal" summary: "fal image and video generation setup in OpenClaw" +title: "Fal" read_when: - You want to use fal image generation in OpenClaw - You need the FAL_KEY auth flow diff --git a/docs/providers/fireworks.md b/docs/providers/fireworks.md index 129b4faf327..0f2d682b1c2 100644 --- a/docs/providers/fireworks.md +++ b/docs/providers/fireworks.md @@ -1,6 +1,6 @@ --- -title: "Fireworks" summary: "Fireworks setup (auth + model selection)" +title: "Fireworks" read_when: - You want to use Fireworks with OpenClaw - You need the Fireworks API key env var or default model id diff --git a/docs/providers/google.md b/docs/providers/google.md index fcfc5bab37c..97aacb9e59d 100644 --- a/docs/providers/google.md +++ b/docs/providers/google.md @@ -1,6 +1,6 @@ --- -title: "Google (Gemini)" summary: "Google Gemini setup (API key + OAuth, image generation, media understanding, TTS, web search)" +title: "Google (Gemini)" read_when: - You want to use Google Gemini models with OpenClaw - You need the API key or OAuth auth flow diff --git a/docs/providers/groq.md b/docs/providers/groq.md index a8e6e3a8324..c6f8ce391bc 100644 --- a/docs/providers/groq.md +++ b/docs/providers/groq.md @@ -1,6 +1,6 @@ --- -title: "Groq" summary: "Groq setup (auth + model selection)" +title: "Groq" read_when: - You want to use Groq with OpenClaw - You need the API key env var or CLI auth choice diff --git a/docs/providers/kilocode.md b/docs/providers/kilocode.md index 153b3b81a0b..8b71441aeb4 100644 --- a/docs/providers/kilocode.md +++ b/docs/providers/kilocode.md @@ -1,6 +1,6 @@ --- -title: "Kilocode" summary: "Use Kilo Gateway's unified API to access many models in OpenClaw" +title: "Kilocode" read_when: - You want a single API key for many LLMs - You want to run models via Kilo Gateway in OpenClaw diff --git a/docs/providers/litellm.md b/docs/providers/litellm.md index 8360e660a33..65f0c75c68d 100644 --- a/docs/providers/litellm.md +++ b/docs/providers/litellm.md @@ -1,6 +1,6 @@ --- -title: "LiteLLM" summary: "Run OpenClaw through LiteLLM Proxy for unified model access and cost tracking" +title: "LiteLLM" read_when: - You want to route OpenClaw through a LiteLLM proxy - You need cost tracking, logging, or model routing through LiteLLM diff --git a/docs/providers/perplexity-provider.md b/docs/providers/perplexity-provider.md index 825bbc7d269..9b2f86db9df 100644 --- a/docs/providers/perplexity-provider.md +++ b/docs/providers/perplexity-provider.md @@ -1,6 +1,6 @@ --- -title: "Perplexity" summary: "Perplexity web search provider setup (API key, search modes, filtering)" +title: "Perplexity" read_when: - You want to configure Perplexity as a web search provider - You need the Perplexity API key or OpenRouter proxy setup diff --git a/docs/providers/qwen_modelstudio.md b/docs/providers/qwen_modelstudio.md index e1a4156885d..07439fe145d 100644 --- a/docs/providers/qwen_modelstudio.md +++ b/docs/providers/qwen_modelstudio.md @@ -1,6 +1,6 @@ --- -title: "Qwen / Model Studio" summary: "Redirect to /providers/qwen" +title: "Qwen / Model Studio" read_when: - You followed an older Model Studio link - You want the canonical Qwen provider page diff --git a/docs/providers/runway.md b/docs/providers/runway.md index b93b7228ac6..021a80f2c64 100644 --- a/docs/providers/runway.md +++ b/docs/providers/runway.md @@ -1,6 +1,6 @@ --- -title: "Runway" summary: "Runway video generation setup in OpenClaw" +title: "Runway" read_when: - You want to use Runway video generation in OpenClaw - You need the Runway API key/env setup diff --git a/docs/providers/tencent.md b/docs/providers/tencent.md index 2cf325648f3..f5934d9b7a9 100644 --- a/docs/providers/tencent.md +++ b/docs/providers/tencent.md @@ -1,6 +1,6 @@ --- -title: "Tencent Cloud (TokenHub)" summary: "Tencent Cloud TokenHub setup for Hy3 preview" +title: "Tencent Cloud (TokenHub)" read_when: - You want to use Tencent Hy3 preview with OpenClaw - You need the TokenHub API key setup diff --git a/docs/providers/together.md b/docs/providers/together.md index f963d682e9f..6f0f6bce81f 100644 --- a/docs/providers/together.md +++ b/docs/providers/together.md @@ -1,6 +1,6 @@ --- -title: "Together AI" summary: "Together AI setup (auth + model selection)" +title: "Together AI" read_when: - You want to use Together AI with OpenClaw - You need the API key env var or CLI auth choice diff --git a/docs/providers/vercel-ai-gateway.md b/docs/providers/vercel-ai-gateway.md index 7566aa75f77..1865702a141 100644 --- a/docs/providers/vercel-ai-gateway.md +++ b/docs/providers/vercel-ai-gateway.md @@ -1,6 +1,6 @@ --- -title: "Vercel AI gateway" summary: "Vercel AI Gateway setup (auth + model selection)" +title: "Vercel AI gateway" read_when: - You want to use Vercel AI Gateway with OpenClaw - You need the API key env var or CLI auth choice diff --git a/docs/providers/volcengine.md b/docs/providers/volcengine.md index 7a2a1a17745..64e8a8de9ee 100644 --- a/docs/providers/volcengine.md +++ b/docs/providers/volcengine.md @@ -1,6 +1,6 @@ --- -title: "Volcengine (Doubao)" summary: "Volcano Engine setup (Doubao models, general + coding endpoints)" +title: "Volcengine (Doubao)" read_when: - You want to use Volcano Engine or Doubao models with OpenClaw - You need the Volcengine API key setup diff --git a/docs/reference/AGENTS.default.md b/docs/reference/AGENTS.default.md index 4f59ba9b552..04066ab3fc6 100644 --- a/docs/reference/AGENTS.default.md +++ b/docs/reference/AGENTS.default.md @@ -1,6 +1,6 @@ --- -title: "Default AGENTS.md" summary: "Default OpenClaw agent instructions and skills roster for the personal assistant setup" +title: "Default AGENTS.md" read_when: - Starting a new OpenClaw agent session - Enabling or auditing default skills diff --git a/docs/reference/RELEASING.md b/docs/reference/RELEASING.md index 66ae655252b..d0e4a50ffb0 100644 --- a/docs/reference/RELEASING.md +++ b/docs/reference/RELEASING.md @@ -1,6 +1,6 @@ --- -title: "Release policy" summary: "Public release channels, version naming, and cadence" +title: "Release policy" read_when: - Looking for public release channel definitions - Looking for version naming and cadence diff --git a/docs/reference/memory-config.md b/docs/reference/memory-config.md index 3eba6167923..8f094a5276d 100644 --- a/docs/reference/memory-config.md +++ b/docs/reference/memory-config.md @@ -1,6 +1,6 @@ --- -title: "Memory configuration reference" summary: "All configuration knobs for memory search, embedding providers, QMD, hybrid search, and multimodal indexing" +title: "Memory configuration reference" read_when: - You want to configure memory search providers or embedding models - You want to set up the QMD backend diff --git a/docs/reference/prompt-caching.md b/docs/reference/prompt-caching.md index 48783416c4c..da7f835e813 100644 --- a/docs/reference/prompt-caching.md +++ b/docs/reference/prompt-caching.md @@ -1,6 +1,6 @@ --- -title: "Prompt caching" summary: "Prompt caching knobs, merge order, provider behavior, and tuning patterns" +title: "Prompt caching" read_when: - You want to reduce prompt token costs with cache retention - You need per-agent cache behavior in multi-agent setups diff --git a/docs/reference/templates/AGENTS.dev.md b/docs/reference/templates/AGENTS.dev.md index f8c15aa49cd..30b7a93abac 100644 --- a/docs/reference/templates/AGENTS.dev.md +++ b/docs/reference/templates/AGENTS.dev.md @@ -1,6 +1,6 @@ --- -title: "AGENTS.dev template" summary: "Dev agent AGENTS.md (C-3PO)" +title: "AGENTS.dev template" read_when: - Using the dev gateway templates - Updating the default dev agent identity diff --git a/docs/reference/templates/AGENTS.md b/docs/reference/templates/AGENTS.md index 4f3a5019739..99853910009 100644 --- a/docs/reference/templates/AGENTS.md +++ b/docs/reference/templates/AGENTS.md @@ -1,6 +1,6 @@ --- -title: "AGENTS.md template" summary: "Workspace template for AGENTS.md" +title: "AGENTS.md template" read_when: - Bootstrapping a workspace manually --- diff --git a/docs/reference/templates/BOOT.md b/docs/reference/templates/BOOT.md index fcad871ad12..7ffa0158116 100644 --- a/docs/reference/templates/BOOT.md +++ b/docs/reference/templates/BOOT.md @@ -1,6 +1,6 @@ --- -title: "BOOT.md template" summary: "Workspace template for BOOT.md" +title: "BOOT.md template" read_when: - Adding a BOOT.md checklist --- diff --git a/docs/reference/templates/BOOTSTRAP.md b/docs/reference/templates/BOOTSTRAP.md index f22b83c5e35..f19c24999ce 100644 --- a/docs/reference/templates/BOOTSTRAP.md +++ b/docs/reference/templates/BOOTSTRAP.md @@ -1,6 +1,6 @@ --- -title: "BOOTSTRAP.md template" summary: "First-run ritual for new agents" +title: "BOOTSTRAP.md template" read_when: - Bootstrapping a workspace manually --- diff --git a/docs/reference/templates/HEARTBEAT.md b/docs/reference/templates/HEARTBEAT.md index 869dadb5721..af3ef9ed557 100644 --- a/docs/reference/templates/HEARTBEAT.md +++ b/docs/reference/templates/HEARTBEAT.md @@ -1,6 +1,6 @@ --- -title: "HEARTBEAT.md template" summary: "Workspace template for HEARTBEAT.md" +title: "HEARTBEAT.md template" read_when: - Bootstrapping a workspace manually --- diff --git a/docs/reference/templates/IDENTITY.dev.md b/docs/reference/templates/IDENTITY.dev.md index 94b358fe3d8..08e607f0d20 100644 --- a/docs/reference/templates/IDENTITY.dev.md +++ b/docs/reference/templates/IDENTITY.dev.md @@ -1,6 +1,6 @@ --- -title: "IDENTITY.dev template" summary: "Dev agent identity (C-3PO)" +title: "IDENTITY.dev template" read_when: - Using the dev gateway templates - Updating the default dev agent identity diff --git a/docs/reference/templates/IDENTITY.md b/docs/reference/templates/IDENTITY.md index 2189caf611f..f0d6a368c3f 100644 --- a/docs/reference/templates/IDENTITY.md +++ b/docs/reference/templates/IDENTITY.md @@ -1,6 +1,6 @@ --- -title: "IDENTITY template" summary: "Agent identity record" +title: "IDENTITY template" read_when: - Bootstrapping a workspace manually --- diff --git a/docs/reference/templates/SOUL.dev.md b/docs/reference/templates/SOUL.dev.md index 81d1e5c70c8..315300b604f 100644 --- a/docs/reference/templates/SOUL.dev.md +++ b/docs/reference/templates/SOUL.dev.md @@ -1,6 +1,6 @@ --- -title: "SOUL.dev template" summary: "Dev agent soul (C-3PO)" +title: "SOUL.dev template" read_when: - Using the dev gateway templates - Updating the default dev agent identity diff --git a/docs/reference/templates/SOUL.md b/docs/reference/templates/SOUL.md index c3834fda0e1..81858ae13c2 100644 --- a/docs/reference/templates/SOUL.md +++ b/docs/reference/templates/SOUL.md @@ -1,6 +1,6 @@ --- -title: "SOUL.md template" summary: "Workspace template for SOUL.md" +title: "SOUL.md template" read_when: - Bootstrapping a workspace manually --- diff --git a/docs/reference/templates/TOOLS.dev.md b/docs/reference/templates/TOOLS.dev.md index 0fc81a93925..e5f6495e2bf 100644 --- a/docs/reference/templates/TOOLS.dev.md +++ b/docs/reference/templates/TOOLS.dev.md @@ -1,6 +1,6 @@ --- -title: "TOOLS.dev template" summary: "Dev agent tools notes (C-3PO)" +title: "TOOLS.dev template" read_when: - Using the dev gateway templates - Updating the default dev agent identity diff --git a/docs/reference/templates/TOOLS.md b/docs/reference/templates/TOOLS.md index df248c0edb9..3b4b0452e6a 100644 --- a/docs/reference/templates/TOOLS.md +++ b/docs/reference/templates/TOOLS.md @@ -1,6 +1,6 @@ --- -title: "TOOLS.md template" summary: "Workspace template for TOOLS.md" +title: "TOOLS.md template" read_when: - Bootstrapping a workspace manually --- diff --git a/docs/reference/templates/USER.dev.md b/docs/reference/templates/USER.dev.md index f9f59a3adf4..6bbcd5fad31 100644 --- a/docs/reference/templates/USER.dev.md +++ b/docs/reference/templates/USER.dev.md @@ -1,6 +1,6 @@ --- -title: "USER.dev template" summary: "Dev agent user profile (C-3PO)" +title: "USER.dev template" read_when: - Using the dev gateway templates - Updating the default dev agent identity diff --git a/docs/reference/templates/USER.md b/docs/reference/templates/USER.md index b3584fbd287..07b7886137d 100644 --- a/docs/reference/templates/USER.md +++ b/docs/reference/templates/USER.md @@ -1,6 +1,6 @@ --- -title: "USER template" summary: "User profile record" +title: "USER template" read_when: - Bootstrapping a workspace manually --- diff --git a/docs/security/CONTRIBUTING-THREAT-MODEL.md b/docs/security/CONTRIBUTING-THREAT-MODEL.md index d5ced086a52..888dd4802aa 100644 --- a/docs/security/CONTRIBUTING-THREAT-MODEL.md +++ b/docs/security/CONTRIBUTING-THREAT-MODEL.md @@ -1,6 +1,6 @@ --- -title: "Contributing to the threat model" summary: "How to contribute to the OpenClaw threat model" +title: "Contributing to the threat model" read_when: - You want to contribute security findings or threat scenarios - Reviewing or updating the threat model diff --git a/docs/security/THREAT-MODEL-ATLAS.md b/docs/security/THREAT-MODEL-ATLAS.md index f70bde882ef..87d9a37b1f1 100644 --- a/docs/security/THREAT-MODEL-ATLAS.md +++ b/docs/security/THREAT-MODEL-ATLAS.md @@ -1,6 +1,6 @@ --- -title: "Threat model (MITRE ATLAS)" summary: "OpenClaw threat model mapped to the MITRE ATLAS framework" +title: "Threat model (MITRE ATLAS)" read_when: - Reviewing security posture or threat scenarios - Working on security features or audit responses diff --git a/docs/security/formal-verification.md b/docs/security/formal-verification.md index a83688a55c3..7cae4cef80f 100644 --- a/docs/security/formal-verification.md +++ b/docs/security/formal-verification.md @@ -1,6 +1,6 @@ --- -title: Formal verification (security models) summary: Machine-checked security models for OpenClaw’s highest-risk paths. +title: Formal verification (security models) read_when: - Reviewing formal security model guarantees or limits - Reproducing or updating TLA+/TLC security model checks diff --git a/docs/start/showcase.md b/docs/start/showcase.md index a39eec63300..0cd165b9e2c 100644 --- a/docs/start/showcase.md +++ b/docs/start/showcase.md @@ -1,7 +1,7 @@ --- +summary: "Community-built projects and integrations powered by OpenClaw" title: "Showcase" description: "Real-world OpenClaw projects from the community" -summary: "Community-built projects and integrations powered by OpenClaw" read_when: - Looking for real OpenClaw usage examples - Updating community project highlights diff --git a/docs/tools/creating-skills.md b/docs/tools/creating-skills.md index 4dc49a44bb3..0b7e88baa4d 100644 --- a/docs/tools/creating-skills.md +++ b/docs/tools/creating-skills.md @@ -1,6 +1,6 @@ --- -title: "Creating skills" summary: "Build and test custom workspace skills with SKILL.md" +title: "Creating skills" read_when: - You are creating a new custom skill in your workspace - You need a quick starter workflow for SKILL.md-based skills diff --git a/docs/tools/diffs.md b/docs/tools/diffs.md index 7d25072b8ab..56e9914b8e9 100644 --- a/docs/tools/diffs.md +++ b/docs/tools/diffs.md @@ -1,6 +1,6 @@ --- -title: "Diffs" summary: "Read-only diff viewer and file renderer for agents (optional plugin tool)" +title: "Diffs" read_when: - You want agents to show code or markdown edits as diffs - You want a canvas-ready viewer URL or a rendered diff file diff --git a/docs/tools/lobster.md b/docs/tools/lobster.md index c0f3d1f1bc1..ba9487d5d05 100644 --- a/docs/tools/lobster.md +++ b/docs/tools/lobster.md @@ -1,6 +1,6 @@ --- -title: Lobster summary: "Typed workflow runtime for OpenClaw with resumable approval gates." +title: Lobster read_when: - You want deterministic multi-step workflows with explicit approvals - You need to resume a workflow without re-running earlier steps diff --git a/docs/tools/loop-detection.md b/docs/tools/loop-detection.md index 48152dcfeda..3a6c09f24c7 100644 --- a/docs/tools/loop-detection.md +++ b/docs/tools/loop-detection.md @@ -1,6 +1,6 @@ --- -title: "Tool-loop detection" summary: "How to enable and tune guardrails that detect repetitive tool-call loops" +title: "Tool-loop detection" read_when: - A user reports agents getting stuck repeating tool calls - You need to tune repetitive-call protection diff --git a/docs/tools/pdf.md b/docs/tools/pdf.md index 3311fca33ac..1dab903d3a8 100644 --- a/docs/tools/pdf.md +++ b/docs/tools/pdf.md @@ -1,6 +1,6 @@ --- -title: "PDF tool" summary: "Analyze one or more PDF documents with native provider support and extraction fallback" +title: "PDF tool" read_when: - You want to analyze PDFs from agents - You need exact pdf tool parameters and limits diff --git a/docs/tools/tokenjuice.md b/docs/tools/tokenjuice.md index 140cd3325cb..c642b0de87f 100644 --- a/docs/tools/tokenjuice.md +++ b/docs/tools/tokenjuice.md @@ -1,6 +1,6 @@ --- -title: "Tokenjuice" summary: "Compact noisy exec and bash tool results with an optional bundled plugin" +title: "Tokenjuice" read_when: - You want shorter `exec` or `bash` tool results in OpenClaw - You want to enable the bundled tokenjuice plugin diff --git a/docs/tools/web.md b/docs/tools/web.md index dd4763c355b..e759ae3de9e 100644 --- a/docs/tools/web.md +++ b/docs/tools/web.md @@ -1,7 +1,7 @@ --- +summary: "web_search, x_search, and web_fetch -- search the web, search X posts, or fetch page content" title: "Web search" sidebarTitle: "Web Search" -summary: "web_search, x_search, and web_fetch -- search the web, search X posts, or fetch page content" read_when: - You want to enable or configure web_search - You want to enable or configure x_search diff --git a/docs/tts.md b/docs/tts.md index 5465a027fc7..f17d8991877 100644 --- a/docs/tts.md +++ b/docs/tts.md @@ -1,6 +1,6 @@ --- -title: "Text-to-speech" summary: "Redirect to /tools/tts" +title: "Text-to-speech" redirect: /tools/tts ---