From 359c6dedbe2ac3dc671d1fe10d755d4a490a23ca Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Sat, 4 Apr 2026 07:43:16 +0100 Subject: [PATCH] docs: prefer channel-core in channel sdk docs --- docs/plugins/sdk-channel-plugins.md | 8 ++++---- docs/plugins/sdk-entrypoints.md | 8 ++++---- docs/plugins/sdk-overview.md | 7 +++++-- docs/plugins/sdk-setup.md | 2 +- 4 files changed, 14 insertions(+), 11 deletions(-) diff --git a/docs/plugins/sdk-channel-plugins.md b/docs/plugins/sdk-channel-plugins.md index 9bd4dc850c3..e09e17faf80 100644 --- a/docs/plugins/sdk-channel-plugins.md +++ b/docs/plugins/sdk-channel-plugins.md @@ -136,8 +136,8 @@ Auth-only channels can usually stop at the default path: core handles approvals import { createChatChannelPlugin, createChannelPluginBase, - } from "openclaw/plugin-sdk/core"; - import type { OpenClawConfig } from "openclaw/plugin-sdk/core"; + } from "openclaw/plugin-sdk/channel-core"; + import type { OpenClawConfig } from "openclaw/plugin-sdk/channel-core"; import { acmeChatApi } from "./client.js"; // your platform API client type ResolvedAccount = { @@ -244,7 +244,7 @@ Auth-only channels can usually stop at the default path: core handles approvals Create `index.ts`: ```typescript index.ts - import { defineChannelPluginEntry } from "openclaw/plugin-sdk/core"; + import { defineChannelPluginEntry } from "openclaw/plugin-sdk/channel-core"; import { acmeChatPlugin } from "./src/channel.js"; export default defineChannelPluginEntry({ @@ -290,7 +290,7 @@ Auth-only channels can usually stop at the default path: core handles approvals Create `setup-entry.ts` for lightweight loading during onboarding: ```typescript setup-entry.ts - import { defineSetupPluginEntry } from "openclaw/plugin-sdk/core"; + import { defineSetupPluginEntry } from "openclaw/plugin-sdk/channel-core"; import { acmeChatPlugin } from "./src/channel.js"; export default defineSetupPluginEntry(acmeChatPlugin); diff --git a/docs/plugins/sdk-entrypoints.md b/docs/plugins/sdk-entrypoints.md index 794a74531bf..6331287a792 100644 --- a/docs/plugins/sdk-entrypoints.md +++ b/docs/plugins/sdk-entrypoints.md @@ -60,14 +60,14 @@ export default definePluginEntry({ ## `defineChannelPluginEntry` -**Import:** `openclaw/plugin-sdk/core` +**Import:** `openclaw/plugin-sdk/channel-core` Wraps `definePluginEntry` with channel-specific wiring. Automatically calls `api.registerChannel({ plugin })`, exposes an optional root-help CLI metadata seam, and gates `registerFull` on registration mode. ```typescript -import { defineChannelPluginEntry } from "openclaw/plugin-sdk/core"; +import { defineChannelPluginEntry } from "openclaw/plugin-sdk/channel-core"; export default defineChannelPluginEntry({ id: "my-channel", @@ -114,13 +114,13 @@ export default defineChannelPluginEntry({ ## `defineSetupPluginEntry` -**Import:** `openclaw/plugin-sdk/core` +**Import:** `openclaw/plugin-sdk/channel-core` For the lightweight `setup-entry.ts` file. Returns just `{ plugin }` with no runtime or CLI wiring. ```typescript -import { defineSetupPluginEntry } from "openclaw/plugin-sdk/core"; +import { defineSetupPluginEntry } from "openclaw/plugin-sdk/channel-core"; export default defineSetupPluginEntry(myChannelPlugin); ``` diff --git a/docs/plugins/sdk-overview.md b/docs/plugins/sdk-overview.md index 31c5d5ca652..65087d2cee7 100644 --- a/docs/plugins/sdk-overview.md +++ b/docs/plugins/sdk-overview.md @@ -26,11 +26,14 @@ Always import from a specific subpath: ```typescript import { definePluginEntry } from "openclaw/plugin-sdk/plugin-entry"; -import { defineChannelPluginEntry } from "openclaw/plugin-sdk/core"; +import { defineChannelPluginEntry } from "openclaw/plugin-sdk/channel-core"; ``` Each subpath is a small, self-contained module. This keeps startup fast and -prevents circular dependency issues. +prevents circular dependency issues. For channel-specific entry/build helpers, +prefer `openclaw/plugin-sdk/channel-core`; keep `openclaw/plugin-sdk/core` for +the broader umbrella surface and shared helpers such as +`buildChannelConfigSchema`. Do not add or depend on provider-named convenience seams such as `openclaw/plugin-sdk/slack`, `openclaw/plugin-sdk/discord`, diff --git a/docs/plugins/sdk-setup.md b/docs/plugins/sdk-setup.md index 9be078b9414..bd00c4e13d5 100644 --- a/docs/plugins/sdk-setup.md +++ b/docs/plugins/sdk-setup.md @@ -178,7 +178,7 @@ disabled channel inspection). ```typescript // setup-entry.ts -import { defineSetupPluginEntry } from "openclaw/plugin-sdk/core"; +import { defineSetupPluginEntry } from "openclaw/plugin-sdk/channel-core"; import { myChannelPlugin } from "./src/channel.js"; export default defineSetupPluginEntry(myChannelPlugin);