mirror of
https://github.com/openclaw/openclaw.git
synced 2026-05-06 15:40:44 +00:00
docs: standardize frontmatter field order (summary before title)
This commit is contained in:
@@ -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
|
||||
---
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
Reference in New Issue
Block a user