From db3237c009a3cce5dd79f27fe9f63e602754cf17 Mon Sep 17 00:00:00 2001 From: "Anthony Fu (via agent)" Date: Fri, 26 Jun 2026 06:24:31 +0000 Subject: [PATCH] docs(plugins): mark all plugins as experimental Flag the first-party @devframes/plugin-* packages as experimental so consumers know their APIs may change before stabilizing. Adds an @experimental JSDoc tag to each plugin's exported devframe factory (a11y, code-server, git, inspect, terminals) and a "> [!WARNING] Experimental" callout to the four plugin READMEs. --- plugins/a11y/README.md | 4 ++++ plugins/a11y/src/index.ts | 3 +++ plugins/code-server/README.md | 4 ++++ plugins/code-server/src/index.ts | 3 +++ plugins/git/README.md | 4 ++++ plugins/git/src/index.ts | 3 +++ plugins/inspect/README.md | 4 ++++ plugins/inspect/src/index.ts | 3 +++ plugins/terminals/src/index.ts | 3 +++ 9 files changed, 31 insertions(+) diff --git a/plugins/a11y/README.md b/plugins/a11y/README.md index 0aa5a83..9a2de38 100644 --- a/plugins/a11y/README.md +++ b/plugins/a11y/README.md @@ -1,5 +1,9 @@ # @devframes/plugin-a11y +> [!WARNING] Experimental +> This plugin is experimental and may change without a major version bump until +> it stabilizes. + An accessibility inspector built on [devframe](../../packages/devframe). It runs [axe-core](https://github.com/dequelabs/axe-core) against a host application, lists the WCAG A/AA violations in a [Solid](https://www.solidjs.com/) panel, and diff --git a/plugins/a11y/src/index.ts b/plugins/a11y/src/index.ts index 0070573..33cfbeb 100644 --- a/plugins/a11y/src/index.ts +++ b/plugins/a11y/src/index.ts @@ -35,6 +35,9 @@ export interface A11yDevframeOptions { * (`/vite`, hub). The panel talks to the in-page agent over a same-origin * BroadcastChannel, so the scan/highlight loop works identically in dev * (live WebSocket RPC) and in a baked static build. + * + * @experimental This plugin is experimental and may change without a major + * version bump until it stabilizes. */ export function createA11yDevframe(options: A11yDevframeOptions = {}): DevframeDefinition { const id = options.id ?? DEFAULT_ID diff --git a/plugins/code-server/README.md b/plugins/code-server/README.md index 730e19e..a3a3196 100644 --- a/plugins/code-server/README.md +++ b/plugins/code-server/README.md @@ -1,5 +1,9 @@ # @devframes/plugin-code-server +> [!WARNING] Experimental +> This plugin is experimental and may change without a major version bump until +> it stabilizes. + Run [code-server](https://github.com/coder/code-server) (VS Code in the browser) as a devframe panel. The plugin detects a local `code-server` install, launches it on demand, and embeds the editor in an diff --git a/plugins/code-server/src/index.ts b/plugins/code-server/src/index.ts index 6f4c182..a6cb989 100644 --- a/plugins/code-server/src/index.ts +++ b/plugins/code-server/src/index.ts @@ -25,6 +25,9 @@ const distDir = fileURLToPath(new URL('../dist/spa', import.meta.url)) * (`/vite`), or docks inside a hub — its `setup` only relies on the core * devframe RPC + shared-state surface. * + * @experimental This plugin is experimental and may change without a major + * version bump until it stabilizes. + * * @example * ```ts * import { createCodeServerDevframe } from '@devframes/plugin-code-server' diff --git a/plugins/git/README.md b/plugins/git/README.md index 57be136..8cbef0f 100644 --- a/plugins/git/README.md +++ b/plugins/git/README.md @@ -1,5 +1,9 @@ # @devframes/plugin-git +> [!WARNING] Experimental +> This plugin is experimental and may change without a major version bump until +> it stabilizes. + Git integration for [devframe](https://github.com/devframes/devframe) — a repository dashboard with a **Next.js App Router + shadcn/ui** SPA over type-safe RPC. The host process shells out to `git` and exposes the repository; diff --git a/plugins/git/src/index.ts b/plugins/git/src/index.ts index e5521c3..fb07dfd 100644 --- a/plugins/git/src/index.ts +++ b/plugins/git/src/index.ts @@ -41,6 +41,9 @@ export interface GitDevframeOptions { /** * Create the Git dashboard devframe. Mount it into any host via devframe's * adapters, or run it standalone with the bundled CLI (`devframe-git`). + * + * @experimental This plugin is experimental and may change without a major + * version bump until it stabilizes. */ export function createGitDevframe(options: GitDevframeOptions = {}): DevframeDefinition { const distDir = options.distDir ?? resolve(PKG_ROOT, 'dist/client') diff --git a/plugins/inspect/README.md b/plugins/inspect/README.md index 553463d..80b9c64 100644 --- a/plugins/inspect/README.md +++ b/plugins/inspect/README.md @@ -1,5 +1,9 @@ # @devframes/plugin-inspect +> [!WARNING] Experimental +> This plugin is experimental and may change without a major version bump until +> it stabilizes. + A devframe plugin that inspects *its own* connection (and, when mounted in a host, the host's): browse every registered RPC function with its metadata, invoke read-only `query`/`static` functions and inspect the results, watch diff --git a/plugins/inspect/src/index.ts b/plugins/inspect/src/index.ts index 8cd0e8e..c902701 100644 --- a/plugins/inspect/src/index.ts +++ b/plugins/inspect/src/index.ts @@ -38,6 +38,9 @@ export interface InspectDevframeOptions { * Build a {@link DevframeDefinition} for the Devframe Inspector. The * same definition runs standalone (`/cli`, `/spa`, `/build`) and mounts * into a host (`/vite`, hub). + * + * @experimental This plugin is experimental and may change without a major + * version bump until it stabilizes. */ export function createInspectDevframe(options: InspectDevframeOptions = {}): DevframeDefinition { const id = options.id ?? DEFAULT_ID diff --git a/plugins/terminals/src/index.ts b/plugins/terminals/src/index.ts index fc9e1dd..65de02e 100644 --- a/plugins/terminals/src/index.ts +++ b/plugins/terminals/src/index.ts @@ -26,6 +26,9 @@ export { * (`/vite`), or docks inside a hub — its `setup` only relies on the core * devframe RPC surface. * + * @experimental This plugin is experimental and may change without a major + * version bump until it stabilizes. + * * @example * ```ts * import { createTerminalsDevframe } from '@devframes/plugin-terminals'