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
3 changes: 3 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,9 @@ jobs:
- name: Typecheck
run: nr typecheck

- name: Docs build
run: pnpm -C docs run docs:build

- name: Knip
run: nr knip
continue-on-error: true
Expand Down
5 changes: 5 additions & 0 deletions .github/workflows/src/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,11 @@ jobs:
- name: Typecheck
run: nr typecheck

# Fail the build when the docs site breaks, so the deployed site never
# silently goes stale (a broken build keeps the last good Netlify deploy).
- name: Docs build
run: pnpm -C docs run docs:build

# Non-blocking until the existing findings are triaged; see knip.jsonc.
- name: Knip
run: nr knip
Expand Down
2 changes: 1 addition & 1 deletion docs/kit/commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ outline: deep

# Commands & Command Palette

DevTools Kit's commands system lets plugins register executable commands on the server and client. Users discover and run them through the built-in command palette, and rebind keyboard shortcuts to taste.
DevTools Kit's commands system lets plugins register executable commands on the server and client. Users discover and run them through the built-in command palette, and rebind keyboard shortcuts to taste. The palette is a [`@devframes/hub`](https://devfra.me/guide/hub) feature surfaced through the kit context.

## Overview

Expand Down
2 changes: 1 addition & 1 deletion docs/kit/diagnostics.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Structured Diagnostics

`ctx.diagnostics` is a thin layer over [`nostics`](https://github.com/vercel-labs/nostics) that lets DevTools plugins register coded errors and warnings into a shared registry without depending on `nostics` directly. Use it for author-defined coded diagnostics — errors, warnings, deprecations — that carry a stable code, a documentation URL, and a structured payload. For free-form runtime output that should appear in the DevTools UI, use [`ctx.messages`](./messages).
`ctx.diagnostics` is a thin layer over [`nostics`](https://github.com/vercel-labs/nostics) that lets DevTools plugins register coded errors and warnings into a shared registry without depending on `nostics` directly. It surfaces [Devframe's diagnostics](https://devfra.me/guide/diagnostics) through the kit context. Use it for author-defined coded diagnostics — errors, warnings, deprecations — that carry a stable code, a documentation URL, and a structured payload. For free-form runtime output that should appear in the DevTools UI, use [`ctx.messages`](./messages).

| Surface | Purpose | Example |
|---------|---------|---------|
Expand Down
2 changes: 1 addition & 1 deletion docs/kit/dock-system.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ outline: deep

# Dock System

Dock entries are how users open your DevTools integration — clickable items in the dock, similar to the macOS Dock.
Dock entries are how users open your DevTools integration — clickable items in the dock, similar to the macOS Dock. The dock is a [`@devframes/hub`](https://devfra.me/guide/hub) feature surfaced through the kit context.

## Entry types

Expand Down
2 changes: 1 addition & 1 deletion docs/kit/json-render.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ outline: deep

# JSON Render

JSON render panels build DevTools UIs from server-side TypeScript alone. You describe the UI as a JSON spec; the DevTools client renders it with the built-in component library.
JSON render panels build DevTools UIs from server-side TypeScript alone. You describe the UI as a JSON spec; the DevTools client renders it with the built-in component library. It builds on [Devframe's JSON-Render](https://devfra.me/guide/json-render).

## Getting started

Expand Down
2 changes: 1 addition & 1 deletion docs/kit/rpc.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ outline: deep

# Remote Procedure Calls (RPC)

DevTools Kit's RPC layer is type-safe, bidirectional, and works between your Node.js server and any connected browser client.
DevTools Kit's RPC layer is type-safe, bidirectional, and works between your Node.js server and any connected browser client. It surfaces [Devframe's RPC](https://devfra.me/guide/rpc) through the kit-augmented context, so these patterns carry over to any Devframe host.

## Overview

Expand Down
2 changes: 1 addition & 1 deletion docs/kit/shared-state.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ outline: deep

# Shared State

DevTools Kit's shared-state system synchronizes data between server and clients. Changes on either side propagate to every connected party.
DevTools Kit's shared-state system synchronizes data between server and clients. Changes on either side propagate to every connected party. It surfaces [Devframe's shared state](https://devfra.me/guide/shared-state) through the kit context.

## Overview

Expand Down
2 changes: 1 addition & 1 deletion docs/kit/when-clauses.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ outline: deep

When clauses are conditional expressions that control visibility and activation of commands and dock entries. The expression language matches [VS Code's when-clause contexts](https://code.visualstudio.com/api/references/when-clause-contexts), evaluated against a reactive context object.

The evaluator is [`whenexpr`](https://github.com/antfu/whenexpr), which also provides the `WhenExpression<Ctx, S>` type helper used by `defineCommand` / `defineDockEntry` for compile-time validation — see [Type-safe `when` clauses](#type-safe-when-clauses).
The evaluator is [`whenexpr`](https://github.com/antfu/whenexpr), which also provides the `WhenExpression<Ctx, S>` type helper used by `defineCommand` / `defineDockEntry` for compile-time validation — see [Type-safe `when` clauses](#type-safe-when-clauses). For the framework-neutral reference, see [Devframe's when clauses](https://devfra.me/references/when-clauses).

## Usage

Expand Down
Loading