Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions plugins/a11y/README.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
3 changes: 3 additions & 0 deletions plugins/a11y/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 4 additions & 0 deletions plugins/code-server/README.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
3 changes: 3 additions & 0 deletions plugins/code-server/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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'
Expand Down
4 changes: 4 additions & 0 deletions plugins/git/README.md
Original file line number Diff line number Diff line change
@@ -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;
Expand Down
3 changes: 3 additions & 0 deletions plugins/git/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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')
Expand Down
4 changes: 4 additions & 0 deletions plugins/inspect/README.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
3 changes: 3 additions & 0 deletions plugins/inspect/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 3 additions & 0 deletions plugins/terminals/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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'
Expand Down
Loading