From 3bffe3e479c65987ab8f91cf356b00fc8debdbcc Mon Sep 17 00:00:00 2001 From: Dotta Date: Sun, 15 Mar 2026 20:30:54 -0500 Subject: [PATCH] docs: update documentation for accuracy after plugin system launch - README: mark plugin system as shipped in roadmap - SPEC: update adapter table with openclaw_gateway, gemini-local, hermes_local - SPEC: update plugin architecture section to reflect shipped status - Add .doc-review-cursor for future maintenance runs Co-Authored-By: Paperclip Co-Authored-By: Claude Opus 4.6 --- .doc-review-cursor | 1 + README.md | 2 +- doc/SPEC.md | 15 +++++++++------ 3 files changed, 11 insertions(+), 7 deletions(-) create mode 100644 .doc-review-cursor diff --git a/.doc-review-cursor b/.doc-review-cursor new file mode 100644 index 00000000..789f2092 --- /dev/null +++ b/.doc-review-cursor @@ -0,0 +1 @@ +16ab8c8 diff --git a/README.md b/README.md index 70ddee5f..391a0feb 100644 --- a/README.md +++ b/README.md @@ -239,7 +239,7 @@ See [doc/DEVELOPING.md](doc/DEVELOPING.md) for the full development guide. - ⚪ ClipMart - buy and sell entire agent companies - ⚪ Easy agent configurations / easier to understand - ⚪ Better support for harness engineering -- ⚪ Plugin system (e.g. if you want to add a knowledgebase, custom tracing, queues, etc) +- 🟢 Plugin system (e.g. if you want to add a knowledgebase, custom tracing, queues, etc) - ⚪ Better docs
diff --git a/doc/SPEC.md b/doc/SPEC.md index 33c24b3a..44cfe8a8 100644 --- a/doc/SPEC.md +++ b/doc/SPEC.md @@ -188,12 +188,15 @@ The heartbeat is a protocol, not a runtime. Paperclip defines how to initiate an Agent configuration includes an **adapter** that defines how Paperclip invokes the agent. Initial adapters: -| Adapter | Mechanism | Example | -| --------- | ----------------------- | --------------------------------------------- | -| `process` | Execute a child process | `python run_agent.py --agent-id {id}` | -| `http` | Send an HTTP request | `POST https://openclaw.example.com/hook/{id}` | +| Adapter | Mechanism | Example | +| -------------------- | ----------------------- | --------------------------------------------- | +| `process` | Execute a child process | `python run_agent.py --agent-id {id}` | +| `http` | Send an HTTP request | `POST https://openclaw.example.com/hook/{id}` | +| `openclaw_gateway` | OpenClaw gateway API | Managed OpenClaw agent via gateway | +| `gemini-local` | Gemini CLI process | Local Gemini CLI with sandbox and approval | +| `hermes_local` | Hermes agent process | Local Hermes agent | -The `process` and `http` adapters ship as defaults. Additional adapters can be added via the plugin system (see Plugin / Extension Architecture). +The `process` and `http` adapters ship as defaults. Additional adapters have been added for specific agent runtimes (see list above), and new adapter types can be registered via the plugin system (see Plugin / Extension Architecture). ### Adapter Interface @@ -429,7 +432,7 @@ The core Paperclip system must be extensible. Features like knowledge bases, ext - **Agent Adapter plugins** — new Adapter types can be registered via the plugin system - Plugin-registrable UI components (future) -This isn't a V1 deliverable (we're not building a plugin framework upfront), but the architecture should not paint us into a corner. Keep boundaries clean so extensions are possible. +The plugin framework has shipped. Plugins can register new adapter types, hook into lifecycle events, and contribute UI components (e.g. global toolbar buttons). A plugin SDK and CLI commands (`paperclipai plugin`) are available for authoring and installing plugins. ---