# Docsloth Registry — full text

> Every page of the registry as Markdown, in catalog order, generated from packages/contracts. The HTML projections live beside them on the market routes and in the publication bundle under /pages/.

---

# Docsloth Registry

Component registry

57 protocol components for agent-readable documentation, served from one catalog. Every entry carries a trust class, a JSON Schema for its props, a specification and an install command, and every generated page ships an HTML and Markdown twin from one source of truth.

## Featured

Six renderer-native blocks from the current catalog. Their example output is produced by `@docsloth/renderer` on every page; the same catalog feeds the per-entry pages and the machine-readable API.

### prose

Readable structured narrative

Trust class: pure · Status: implemented_native · Renderer: native block

```sh
docsloth component add @docsloth/prose@1.0.0
```

### callout

Important contextual warnings

Trust class: pure · Status: implemented_native · Renderer: native block

```sh
docsloth component add @docsloth/callout@1.0.0
```

### code

Syntax-highlighted copyable code

Trust class: interactive · Status: implemented_native · Renderer: native block

```sh
docsloth component add @docsloth/code@1.0.0
```

### table

Filterable structured reference

Trust class: interactive · Status: implemented_native · Renderer: native block

```sh
docsloth component add @docsloth/table@1.0.0
```

### tabs

Switch related presentations

Trust class: interactive · Status: implemented_native · Renderer: native block

```sh
docsloth component add @docsloth/tabs@1.0.0
```

### steps

Ordered walkthrough steps

Trust class: pure · Status: implemented_native · Renderer: native block

```sh
docsloth component add @docsloth/steps@1.0.0
```

## Categories

The registry is organised into category routes. Membership is derived from the catalog, so a category with no matching entry renders an honest empty state instead of a placeholder listing.

| Category | Route | Entries | Status |
| --- | --- | --- | --- |
| [Components](https://registry.docsloth.dev/components) | [/components](https://registry.docsloth.dev/components) | 57 | populated from the catalog |
| [Blocks](https://registry.docsloth.dev/blocks) | [/blocks](https://registry.docsloth.dev/blocks) | 57 | populated from the catalog |
| [Templates](https://registry.docsloth.dev/templates) | [/templates](https://registry.docsloth.dev/templates) | 0 | roadmap — honest empty state |
| [Themes](https://registry.docsloth.dev/themes) | [/themes](https://registry.docsloth.dev/themes) | 0 | roadmap — honest empty state |
| [Adapters](https://registry.docsloth.dev/adapters) | [/adapters](https://registry.docsloth.dev/adapters) | 0 | roadmap — honest empty state |
| [Recipes](https://registry.docsloth.dev/recipes) | [/recipes](https://registry.docsloth.dev/recipes) | 0 | roadmap — honest empty state |

## All components

### prose

Readable structured narrative

Trust class: pure · Status: implemented_native · Renderer: native block

```sh
docsloth component add @docsloth/prose@1.0.0
```

### callout

Important contextual warnings

Trust class: pure · Status: implemented_native · Renderer: native block

```sh
docsloth component add @docsloth/callout@1.0.0
```

### tabs

Switch related presentations

Trust class: interactive · Status: implemented_native · Renderer: native block

```sh
docsloth component add @docsloth/tabs@1.0.0
```

### table

Filterable structured reference

Trust class: interactive · Status: implemented_native · Renderer: native block

```sh
docsloth component add @docsloth/table@1.0.0
```

### code

Syntax-highlighted copyable code

Trust class: interactive · Status: implemented_native · Renderer: native block

```sh
docsloth component add @docsloth/code@1.0.0
```

### code-diff

Inspect a versioned example change

Trust class: interactive · Status: implemented_native · Renderer: native block

```sh
docsloth component add @docsloth/code-diff@1.0.0
```

### live-code

Execute an example in an approved environment

Trust class: connected · Status: implemented_native · Renderer: native block

```sh
docsloth component add @docsloth/live-code@1.0.0
```

### terminal

Interactive command example with sandbox binding

Trust class: connected · Status: implemented_native · Renderer: native block

```sh
docsloth component add @docsloth/terminal@1.0.0
```

### api-console

Build and send approved API requests

Trust class: connected · Status: implemented_native · Renderer: native block

```sh
docsloth component add @docsloth/api-console@1.0.0
```

### api-reference

Render canonical API schema and examples

Trust class: pure · Status: implemented_native · Renderer: native block

```sh
docsloth component add @docsloth/api-reference@1.0.0
```

### schema-explorer

Explore an object or database schema

Trust class: interactive · Status: implemented_native · Renderer: native block

```sh
docsloth component add @docsloth/schema-explorer@1.0.0
```

### graph

Explore services and software relationships

Trust class: interactive · Status: implemented_native · Renderer: native block

```sh
docsloth component add @docsloth/graph@1.0.0
```

### sequence

Explain message ordering

Trust class: interactive · Status: implemented_native · Renderer: native block

```sh
docsloth component add @docsloth/sequence@1.0.0
```

### state-machine

Explore a bounded state machine

Trust class: interactive · Status: implemented_native · Renderer: native block

```sh
docsloth component add @docsloth/state-machine@1.0.0
```

### tutorial

Verified multistep task tutorial

Trust class: connected · Status: implemented_native · Renderer: native block

```sh
docsloth component add @docsloth/tutorial@1.0.0
```

### wizard

Collect configuration and validate prerequisites

Trust class: connected · Status: implemented_native · Renderer: native block

```sh
docsloth component add @docsloth/wizard@1.0.0
```

### chat

Page-scoped sourced documentation assistance

Trust class: agentic · Status: implemented_native · Renderer: native block

```sh
docsloth component add @docsloth/chat@1.0.0
```

### chat-bubble

Floating contextual documentation assistant

Trust class: agentic · Status: implemented_native · Renderer: native block

```sh
docsloth component add @docsloth/chat-bubble@1.0.0
```

### troubleshooter

Diagnose an authorized redacted error

Trust class: agentic · Status: implemented_native · Renderer: native block

```sh
docsloth component add @docsloth/troubleshooter@1.0.0
```

### agent-task

Run a scoped documentation task

Trust class: agentic · Status: implemented_native · Renderer: native block

```sh
docsloth component add @docsloth/agent-task@1.0.0
```

### search

Published content search with static fallback

Trust class: interactive · Status: implemented_native · Renderer: native block

```sh
docsloth component add @docsloth/search@1.0.0
```

### video

Accessible recorded walkthrough

Trust class: interactive · Status: implemented_native · Renderer: native block

```sh
docsloth component add @docsloth/video@1.0.0
```

### gif

Short annotated motion with static alternative

Trust class: pure · Status: implemented_native · Renderer: native block

```sh
docsloth component add @docsloth/gif@1.0.0
```

### image

Accessible versioned screenshot

Trust class: pure · Status: implemented_native · Renderer: native block

```sh
docsloth component add @docsloth/image@1.0.0
```

### release-timeline

Published version and migration history

Trust class: interactive · Status: implemented_native · Renderer: native block

```sh
docsloth component add @docsloth/release-timeline@1.0.0
```

### migration

Before-and-after change guide

Trust class: interactive · Status: implemented_native · Renderer: native block

```sh
docsloth component add @docsloth/migration@1.0.0
```

### permissions

Read-only permission matrix

Trust class: interactive · Status: implemented_native · Renderer: native block

```sh
docsloth component add @docsloth/permissions@1.0.0
```

### configurator

Prepare safe software configuration

Trust class: connected · Status: implemented_native · Renderer: native block

```sh
docsloth component add @docsloth/configurator@1.0.0
```

### webhook-debugger

Inspect synthetic approved webhook delivery

Trust class: connected · Status: implemented_native · Renderer: native block

```sh
docsloth component add @docsloth/webhook-debugger@1.0.0
```

### event-stream

Inspect an authorized event stream

Trust class: connected · Status: implemented_native · Renderer: native block

```sh
docsloth component add @docsloth/event-stream@1.0.0
```

### logs

View redacted approved diagnostic logs

Trust class: connected · Status: implemented_native · Renderer: native block

```sh
docsloth component add @docsloth/logs@1.0.0
```

### status

Read-only authorized deployment status

Trust class: connected · Status: implemented_native · Renderer: native block

```sh
docsloth component add @docsloth/status@1.0.0
```

### feedback

Submit bounded document feedback

Trust class: connected · Status: implemented_native · Renderer: native block

```sh
docsloth component add @docsloth/feedback@1.0.0
```

### checklist

Track local tutorial progress

Trust class: interactive · Status: implemented_native · Renderer: native block

```sh
docsloth component add @docsloth/checklist@1.0.0
```

### cards

Choose task-oriented navigation

Trust class: pure · Status: implemented_native · Renderer: native block

```sh
docsloth component add @docsloth/cards@1.0.0
```

### breadcrumbs

Show page hierarchy

Trust class: pure · Status: implemented_native · Renderer: native block

```sh
docsloth component add @docsloth/breadcrumbs@1.0.0
```

### version-selector

Choose an actual available release

Trust class: interactive · Status: implemented_native · Renderer: native block

```sh
docsloth component add @docsloth/version-selector@1.0.0
```

### locale-selector

Choose an available language

Trust class: interactive · Status: implemented_native · Renderer: native block

```sh
docsloth component add @docsloth/locale-selector@1.0.0
```

### copy-context

Export permitted agent context

Trust class: connected · Status: implemented_native · Renderer: native block

```sh
docsloth component add @docsloth/copy-context@1.0.0
```

### apply-to-repo

Prepare a reader-authorized integration PR

Trust class: agentic · Status: implemented_native · Renderer: native block

```sh
docsloth component add @docsloth/apply-to-repo@1.0.0
```

### embed

Isolated approved external UI

Trust class: connected · Status: implemented_native · Renderer: native block

```sh
docsloth component add @docsloth/embed@1.0.0
```

### metrics

Display authorized aggregate metrics

Trust class: connected · Status: implemented_native · Renderer: native block

```sh
docsloth component add @docsloth/metrics@1.0.0
```

### media-transcript

Accessible transcript tied to media version

Trust class: pure · Status: implemented_native · Renderer: native block

```sh
docsloth component add @docsloth/media-transcript@1.0.0
```

### faq

Task-oriented evidenced question answers

Trust class: pure · Status: implemented_native · Renderer: native block

```sh
docsloth component add @docsloth/faq@1.0.0
```

### glossary

Software terminology and concepts

Trust class: interactive · Status: implemented_native · Renderer: native block

```sh
docsloth component add @docsloth/glossary@1.0.0
```

### download

Integrity-checked approved artifact download

Trust class: connected · Status: implemented_native · Renderer: native block

```sh
docsloth component add @docsloth/download@1.0.0
```

### pricing-reference

Owner-sourced product prices; never inferred from code

Trust class: pure · Status: implemented_native · Renderer: native block

```sh
docsloth component add @docsloth/pricing-reference@1.0.0
```

### source-evidence

Expose audience-safe verification evidence

Trust class: interactive · Status: implemented_native · Renderer: native block

```sh
docsloth component add @docsloth/source-evidence@1.0.0
```

### steps

Ordered walkthrough steps

Trust class: pure · Status: implemented_native · Renderer: native block

```sh
docsloth component add @docsloth/steps@1.0.0
```

### accordion

Progressive disclosure of optional detail

Trust class: interactive · Status: implemented_native · Renderer: native block

```sh
docsloth component add @docsloth/accordion@1.0.0
```

### badge

Compact status label

Trust class: pure · Status: implemented_native · Renderer: native block

```sh
docsloth component add @docsloth/badge@1.0.0
```

### kbd

Keyboard shortcut chord

Trust class: pure · Status: implemented_native · Renderer: native block

```sh
docsloth component add @docsloth/kbd@1.0.0
```

### api-playground

Describe an API request without executing it

Trust class: interactive · Status: implemented_native · Renderer: native block

```sh
docsloth component add @docsloth/api-playground@1.0.0
```

### openapi-operation

Static OpenAPI operation reference

Trust class: pure · Status: implemented_native · Renderer: native block

```sh
docsloth component add @docsloth/openapi-operation@1.0.0
```

### mermaid

Mermaid diagram source kept readable for agents

Trust class: interactive · Status: implemented_native · Renderer: native block

```sh
docsloth component add @docsloth/mermaid@1.0.0
```

### code-group

Labelled alternative code samples

Trust class: interactive · Status: implemented_native · Renderer: native block

```sh
docsloth component add @docsloth/code-group@1.0.0
```

### versioned-content

Version-scoped content region

Trust class: pure · Status: implemented_native · Renderer: native block

```sh
docsloth component add @docsloth/versioned-content@1.0.0
```

## Publishing

Components enter the registry as declarative packages: build from source, publish to a registry, and the catalog index picks the entry up. The full contract — package kinds, the `POST /v1/packages` call, tokens and immutability rules — is in [/publish](https://registry.docsloth.dev/publish) and machine-readable at [/api/v1/publish.json](https://registry.docsloth.dev/api/v1/publish.json).

```sh
docsloth component build --dir ./package
docsloth component publish --dir ./package --registry https://registry.docsloth.dev
```

## Trust classes

| Trust class | Components | Contract |
| --- | --- | --- |
| pure | 15 | pure render; no side effects, network or permission states |
| interactive | 22 | local interaction only; no network or secrets |
| connected | 15 | requires an explicit host capability grant; never receives raw credentials |
| agentic | 5 | proposes named tools; every effect is host-authorized per call |

## Agent surfaces

The registry publishes agent surfaces next to the human pages: llms.txt (root index), llms-full.txt (every page as Markdown), one scoped index per trust class under _llms/, catalog.json (machine-readable catalog), the machine-readable /api/v1 (search index, catalog, per-component metadata, version resolution and the publishing contract), sitemap.xml, and a Markdown twin for every page.

## Status

All 57 entries carry the catalog's implementation status (57 `implemented_native` today). The status shown per component is the catalog value, not a marketing claim; when the catalog changes, this site changes with it.


---

# Components

Registry category `/components` — every entry in packages/contracts/component-catalog.json, whatever its package kind.

| Field | Value |
| --- | --- |
| Route | [/components](https://registry.docsloth.dev/components) |
| Catalog entries | 57 |
| Status | populated from the current catalog |
| Source of truth | packages/contracts/component-catalog.json |

## Components entries (57)

| Component | Trust class | Status | Renderer |
| --- | --- | --- | --- |
| [prose](https://registry.docsloth.dev/components/prose.html) | pure | implemented_native | native block |
| [callout](https://registry.docsloth.dev/components/callout.html) | pure | implemented_native | native block |
| [tabs](https://registry.docsloth.dev/components/tabs.html) | interactive | implemented_native | native block |
| [table](https://registry.docsloth.dev/components/table.html) | interactive | implemented_native | native block |
| [code](https://registry.docsloth.dev/components/code.html) | interactive | implemented_native | native block |
| [code-diff](https://registry.docsloth.dev/components/code-diff.html) | interactive | implemented_native | native block |
| [live-code](https://registry.docsloth.dev/components/live-code.html) | connected | implemented_native | native block |
| [terminal](https://registry.docsloth.dev/components/terminal.html) | connected | implemented_native | native block |
| [api-console](https://registry.docsloth.dev/components/api-console.html) | connected | implemented_native | native block |
| [api-reference](https://registry.docsloth.dev/components/api-reference.html) | pure | implemented_native | native block |
| [schema-explorer](https://registry.docsloth.dev/components/schema-explorer.html) | interactive | implemented_native | native block |
| [graph](https://registry.docsloth.dev/components/graph.html) | interactive | implemented_native | native block |
| [sequence](https://registry.docsloth.dev/components/sequence.html) | interactive | implemented_native | native block |
| [state-machine](https://registry.docsloth.dev/components/state-machine.html) | interactive | implemented_native | native block |
| [tutorial](https://registry.docsloth.dev/components/tutorial.html) | connected | implemented_native | native block |
| [wizard](https://registry.docsloth.dev/components/wizard.html) | connected | implemented_native | native block |
| [chat](https://registry.docsloth.dev/components/chat.html) | agentic | implemented_native | native block |
| [chat-bubble](https://registry.docsloth.dev/components/chat-bubble.html) | agentic | implemented_native | native block |
| [troubleshooter](https://registry.docsloth.dev/components/troubleshooter.html) | agentic | implemented_native | native block |
| [agent-task](https://registry.docsloth.dev/components/agent-task.html) | agentic | implemented_native | native block |
| [search](https://registry.docsloth.dev/components/search.html) | interactive | implemented_native | native block |
| [video](https://registry.docsloth.dev/components/video.html) | interactive | implemented_native | native block |
| [gif](https://registry.docsloth.dev/components/gif.html) | pure | implemented_native | native block |
| [image](https://registry.docsloth.dev/components/image.html) | pure | implemented_native | native block |
| [release-timeline](https://registry.docsloth.dev/components/release-timeline.html) | interactive | implemented_native | native block |
| [migration](https://registry.docsloth.dev/components/migration.html) | interactive | implemented_native | native block |
| [permissions](https://registry.docsloth.dev/components/permissions.html) | interactive | implemented_native | native block |
| [configurator](https://registry.docsloth.dev/components/configurator.html) | connected | implemented_native | native block |
| [webhook-debugger](https://registry.docsloth.dev/components/webhook-debugger.html) | connected | implemented_native | native block |
| [event-stream](https://registry.docsloth.dev/components/event-stream.html) | connected | implemented_native | native block |
| [logs](https://registry.docsloth.dev/components/logs.html) | connected | implemented_native | native block |
| [status](https://registry.docsloth.dev/components/status.html) | connected | implemented_native | native block |
| [feedback](https://registry.docsloth.dev/components/feedback.html) | connected | implemented_native | native block |
| [checklist](https://registry.docsloth.dev/components/checklist.html) | interactive | implemented_native | native block |
| [cards](https://registry.docsloth.dev/components/cards.html) | pure | implemented_native | native block |
| [breadcrumbs](https://registry.docsloth.dev/components/breadcrumbs.html) | pure | implemented_native | native block |
| [version-selector](https://registry.docsloth.dev/components/version-selector.html) | interactive | implemented_native | native block |
| [locale-selector](https://registry.docsloth.dev/components/locale-selector.html) | interactive | implemented_native | native block |
| [copy-context](https://registry.docsloth.dev/components/copy-context.html) | connected | implemented_native | native block |
| [apply-to-repo](https://registry.docsloth.dev/components/apply-to-repo.html) | agentic | implemented_native | native block |
| [embed](https://registry.docsloth.dev/components/embed.html) | connected | implemented_native | native block |
| [metrics](https://registry.docsloth.dev/components/metrics.html) | connected | implemented_native | native block |
| [media-transcript](https://registry.docsloth.dev/components/media-transcript.html) | pure | implemented_native | native block |
| [faq](https://registry.docsloth.dev/components/faq.html) | pure | implemented_native | native block |
| [glossary](https://registry.docsloth.dev/components/glossary.html) | interactive | implemented_native | native block |
| [download](https://registry.docsloth.dev/components/download.html) | connected | implemented_native | native block |
| [pricing-reference](https://registry.docsloth.dev/components/pricing-reference.html) | pure | implemented_native | native block |
| [source-evidence](https://registry.docsloth.dev/components/source-evidence.html) | interactive | implemented_native | native block |
| [steps](https://registry.docsloth.dev/components/steps.html) | pure | implemented_native | native block |
| [accordion](https://registry.docsloth.dev/components/accordion.html) | interactive | implemented_native | native block |
| [badge](https://registry.docsloth.dev/components/badge.html) | pure | implemented_native | native block |
| [kbd](https://registry.docsloth.dev/components/kbd.html) | pure | implemented_native | native block |
| [api-playground](https://registry.docsloth.dev/components/api-playground.html) | interactive | implemented_native | native block |
| [openapi-operation](https://registry.docsloth.dev/components/openapi-operation.html) | pure | implemented_native | native block |
| [mermaid](https://registry.docsloth.dev/components/mermaid.html) | interactive | implemented_native | native block |
| [code-group](https://registry.docsloth.dev/components/code-group.html) | interactive | implemented_native | native block |
| [versioned-content](https://registry.docsloth.dev/components/versioned-content.html) | pure | implemented_native | native block |

Machine metadata: every entry is served as JSON under [/api/v1](https://registry.docsloth.dev/api/v1/index.json); per-entry metadata and version resolution live at `/api/v1/components/<name>.json`.

All 57 entries in the current catalog are installable block packages; the [blocks category](https://registry.docsloth.dev/blocks) is the install-oriented view of the same catalog, and the [templates](https://registry.docsloth.dev/templates), [themes](https://registry.docsloth.dev/themes), [adapters](https://registry.docsloth.dev/adapters) and [recipes](https://registry.docsloth.dev/recipes) routes are roadmap categories with honest empty states until entries are registered.

## Other categories

Category membership is derived from the single catalog read by the generator; an empty category means the catalog has no matching entry today.

| Category | Route | Entries | Status |
| --- | --- | --- | --- |
| [Components](https://registry.docsloth.dev/components) | [/components](https://registry.docsloth.dev/components) | 57 | populated |
| [Blocks](https://registry.docsloth.dev/blocks) | [/blocks](https://registry.docsloth.dev/blocks) | 57 | populated |
| [Templates](https://registry.docsloth.dev/templates) | [/templates](https://registry.docsloth.dev/templates) | 0 | roadmap |
| [Themes](https://registry.docsloth.dev/themes) | [/themes](https://registry.docsloth.dev/themes) | 0 | roadmap |
| [Adapters](https://registry.docsloth.dev/adapters) | [/adapters](https://registry.docsloth.dev/adapters) | 0 | roadmap |
| [Recipes](https://registry.docsloth.dev/recipes) | [/recipes](https://registry.docsloth.dev/recipes) | 0 | roadmap |


---

# Blocks

Registry category `/blocks` — catalog entries that resolve to a renderer-native document-IR block.

| Field | Value |
| --- | --- |
| Route | [/blocks](https://registry.docsloth.dev/blocks) |
| Catalog entries | 57 |
| Status | populated from the current catalog |
| Source of truth | packages/contracts/component-catalog.json |

## Blocks entries (57)

| Block | Package | Version | Digest | Install |
| --- | --- | --- | --- | --- |
| [prose](https://registry.docsloth.dev/components/prose.html) | @docsloth/prose | 1.0.0 | sha256:d4b0bbe677092b9f… | `docsloth component add @docsloth/prose@1.0.0` |
| [callout](https://registry.docsloth.dev/components/callout.html) | @docsloth/callout | 1.0.0 | sha256:584792d30684ff49… | `docsloth component add @docsloth/callout@1.0.0` |
| [tabs](https://registry.docsloth.dev/components/tabs.html) | @docsloth/tabs | 1.0.0 | sha256:2b5dfd26ede0e42e… | `docsloth component add @docsloth/tabs@1.0.0` |
| [table](https://registry.docsloth.dev/components/table.html) | @docsloth/table | 1.0.0 | sha256:9eb3021214ce7a96… | `docsloth component add @docsloth/table@1.0.0` |
| [code](https://registry.docsloth.dev/components/code.html) | @docsloth/code | 1.0.0 | sha256:f8b010a4d36aafdd… | `docsloth component add @docsloth/code@1.0.0` |
| [code-diff](https://registry.docsloth.dev/components/code-diff.html) | @docsloth/code-diff | 1.0.0 | sha256:8c0bab13a0340978… | `docsloth component add @docsloth/code-diff@1.0.0` |
| [live-code](https://registry.docsloth.dev/components/live-code.html) | @docsloth/live-code | 1.0.0 | sha256:337712c7adaa1265… | `docsloth component add @docsloth/live-code@1.0.0` |
| [terminal](https://registry.docsloth.dev/components/terminal.html) | @docsloth/terminal | 1.0.0 | sha256:914d3972d1e95775… | `docsloth component add @docsloth/terminal@1.0.0` |
| [api-console](https://registry.docsloth.dev/components/api-console.html) | @docsloth/api-console | 1.0.0 | sha256:e2d2026301632769… | `docsloth component add @docsloth/api-console@1.0.0` |
| [api-reference](https://registry.docsloth.dev/components/api-reference.html) | @docsloth/api-reference | 1.0.0 | sha256:f160e0216f9fe7a0… | `docsloth component add @docsloth/api-reference@1.0.0` |
| [schema-explorer](https://registry.docsloth.dev/components/schema-explorer.html) | @docsloth/schema-explorer | 1.0.0 | sha256:6ef70bb86f675d5c… | `docsloth component add @docsloth/schema-explorer@1.0.0` |
| [graph](https://registry.docsloth.dev/components/graph.html) | @docsloth/graph | 1.0.0 | sha256:6d641e2333187733… | `docsloth component add @docsloth/graph@1.0.0` |
| [sequence](https://registry.docsloth.dev/components/sequence.html) | @docsloth/sequence | 1.0.0 | sha256:a080361d569b2b4b… | `docsloth component add @docsloth/sequence@1.0.0` |
| [state-machine](https://registry.docsloth.dev/components/state-machine.html) | @docsloth/state-machine | 1.0.0 | sha256:91bd9464a06f102f… | `docsloth component add @docsloth/state-machine@1.0.0` |
| [tutorial](https://registry.docsloth.dev/components/tutorial.html) | @docsloth/tutorial | 1.0.0 | sha256:d8935cd3b71884c7… | `docsloth component add @docsloth/tutorial@1.0.0` |
| [wizard](https://registry.docsloth.dev/components/wizard.html) | @docsloth/wizard | 1.0.0 | sha256:500b2eb0f2f3cd3c… | `docsloth component add @docsloth/wizard@1.0.0` |
| [chat](https://registry.docsloth.dev/components/chat.html) | @docsloth/chat | 1.0.0 | sha256:55a9c459b0ce2a7b… | `docsloth component add @docsloth/chat@1.0.0` |
| [chat-bubble](https://registry.docsloth.dev/components/chat-bubble.html) | @docsloth/chat-bubble | 1.0.0 | sha256:f2e372a38f97e05c… | `docsloth component add @docsloth/chat-bubble@1.0.0` |
| [troubleshooter](https://registry.docsloth.dev/components/troubleshooter.html) | @docsloth/troubleshooter | 1.0.0 | sha256:cc7e3d2eb1477955… | `docsloth component add @docsloth/troubleshooter@1.0.0` |
| [agent-task](https://registry.docsloth.dev/components/agent-task.html) | @docsloth/agent-task | 1.0.0 | sha256:493a794a66adc031… | `docsloth component add @docsloth/agent-task@1.0.0` |
| [search](https://registry.docsloth.dev/components/search.html) | @docsloth/search | 1.0.0 | sha256:17cff85734c80028… | `docsloth component add @docsloth/search@1.0.0` |
| [video](https://registry.docsloth.dev/components/video.html) | @docsloth/video | 1.0.0 | sha256:5e1d7e446c9173e2… | `docsloth component add @docsloth/video@1.0.0` |
| [gif](https://registry.docsloth.dev/components/gif.html) | @docsloth/gif | 1.0.0 | sha256:deb4d9079a20d46f… | `docsloth component add @docsloth/gif@1.0.0` |
| [image](https://registry.docsloth.dev/components/image.html) | @docsloth/image | 1.0.0 | sha256:916c97ac0ee5c5bc… | `docsloth component add @docsloth/image@1.0.0` |
| [release-timeline](https://registry.docsloth.dev/components/release-timeline.html) | @docsloth/release-timeline | 1.0.0 | sha256:4f0e51678b85f762… | `docsloth component add @docsloth/release-timeline@1.0.0` |
| [migration](https://registry.docsloth.dev/components/migration.html) | @docsloth/migration | 1.0.0 | sha256:1e33029c22b4ace4… | `docsloth component add @docsloth/migration@1.0.0` |
| [permissions](https://registry.docsloth.dev/components/permissions.html) | @docsloth/permissions | 1.0.0 | sha256:4723e1b392af90ca… | `docsloth component add @docsloth/permissions@1.0.0` |
| [configurator](https://registry.docsloth.dev/components/configurator.html) | @docsloth/configurator | 1.0.0 | sha256:97c8deb6cdb1b954… | `docsloth component add @docsloth/configurator@1.0.0` |
| [webhook-debugger](https://registry.docsloth.dev/components/webhook-debugger.html) | @docsloth/webhook-debugger | 1.0.0 | sha256:84dab19a37c1a8b2… | `docsloth component add @docsloth/webhook-debugger@1.0.0` |
| [event-stream](https://registry.docsloth.dev/components/event-stream.html) | @docsloth/event-stream | 1.0.0 | sha256:562d76e0327281cf… | `docsloth component add @docsloth/event-stream@1.0.0` |
| [logs](https://registry.docsloth.dev/components/logs.html) | @docsloth/logs | 1.0.0 | sha256:ab7d4448c13820a9… | `docsloth component add @docsloth/logs@1.0.0` |
| [status](https://registry.docsloth.dev/components/status.html) | @docsloth/status | 1.0.0 | sha256:595525426f7f977b… | `docsloth component add @docsloth/status@1.0.0` |
| [feedback](https://registry.docsloth.dev/components/feedback.html) | @docsloth/feedback | 1.0.0 | sha256:ea984d36a3eb7427… | `docsloth component add @docsloth/feedback@1.0.0` |
| [checklist](https://registry.docsloth.dev/components/checklist.html) | @docsloth/checklist | 1.0.0 | sha256:90d811d2436bb54d… | `docsloth component add @docsloth/checklist@1.0.0` |
| [cards](https://registry.docsloth.dev/components/cards.html) | @docsloth/cards | 1.0.0 | sha256:135257635d5f1c26… | `docsloth component add @docsloth/cards@1.0.0` |
| [breadcrumbs](https://registry.docsloth.dev/components/breadcrumbs.html) | @docsloth/breadcrumbs | 1.0.0 | sha256:eb968b49affbedc9… | `docsloth component add @docsloth/breadcrumbs@1.0.0` |
| [version-selector](https://registry.docsloth.dev/components/version-selector.html) | @docsloth/version-selector | 1.0.0 | sha256:124601d299ec95bd… | `docsloth component add @docsloth/version-selector@1.0.0` |
| [locale-selector](https://registry.docsloth.dev/components/locale-selector.html) | @docsloth/locale-selector | 1.0.0 | sha256:e44ff75e611cc9dc… | `docsloth component add @docsloth/locale-selector@1.0.0` |
| [copy-context](https://registry.docsloth.dev/components/copy-context.html) | @docsloth/copy-context | 1.0.0 | sha256:7384e22a62ec776e… | `docsloth component add @docsloth/copy-context@1.0.0` |
| [apply-to-repo](https://registry.docsloth.dev/components/apply-to-repo.html) | @docsloth/apply-to-repo | 1.0.0 | sha256:3314002b84cf7826… | `docsloth component add @docsloth/apply-to-repo@1.0.0` |
| [embed](https://registry.docsloth.dev/components/embed.html) | @docsloth/embed | 1.0.0 | sha256:77645d8b323a2fc8… | `docsloth component add @docsloth/embed@1.0.0` |
| [metrics](https://registry.docsloth.dev/components/metrics.html) | @docsloth/metrics | 1.0.0 | sha256:689a423f12cd771f… | `docsloth component add @docsloth/metrics@1.0.0` |
| [media-transcript](https://registry.docsloth.dev/components/media-transcript.html) | @docsloth/media-transcript | 1.0.0 | sha256:ed248c31e409e5b4… | `docsloth component add @docsloth/media-transcript@1.0.0` |
| [faq](https://registry.docsloth.dev/components/faq.html) | @docsloth/faq | 1.0.0 | sha256:7bb429cc396b17aa… | `docsloth component add @docsloth/faq@1.0.0` |
| [glossary](https://registry.docsloth.dev/components/glossary.html) | @docsloth/glossary | 1.0.0 | sha256:4c45f87cd38b58fb… | `docsloth component add @docsloth/glossary@1.0.0` |
| [download](https://registry.docsloth.dev/components/download.html) | @docsloth/download | 1.0.0 | sha256:f1a556413ebbbde3… | `docsloth component add @docsloth/download@1.0.0` |
| [pricing-reference](https://registry.docsloth.dev/components/pricing-reference.html) | @docsloth/pricing-reference | 1.0.0 | sha256:ae1e3fa052f90eca… | `docsloth component add @docsloth/pricing-reference@1.0.0` |
| [source-evidence](https://registry.docsloth.dev/components/source-evidence.html) | @docsloth/source-evidence | 1.0.0 | sha256:91585e02b9857ea1… | `docsloth component add @docsloth/source-evidence@1.0.0` |
| [steps](https://registry.docsloth.dev/components/steps.html) | @docsloth/steps | 1.0.0 | sha256:0ba6c7b14beefa47… | `docsloth component add @docsloth/steps@1.0.0` |
| [accordion](https://registry.docsloth.dev/components/accordion.html) | @docsloth/accordion | 1.0.0 | sha256:320b0d6b28817df9… | `docsloth component add @docsloth/accordion@1.0.0` |
| [badge](https://registry.docsloth.dev/components/badge.html) | @docsloth/badge | 1.0.0 | sha256:861bab9e5ab9cd4f… | `docsloth component add @docsloth/badge@1.0.0` |
| [kbd](https://registry.docsloth.dev/components/kbd.html) | @docsloth/kbd | 1.0.0 | sha256:e8a75f9817fa29cb… | `docsloth component add @docsloth/kbd@1.0.0` |
| [api-playground](https://registry.docsloth.dev/components/api-playground.html) | @docsloth/api-playground | 1.0.0 | sha256:e32a8142a4770416… | `docsloth component add @docsloth/api-playground@1.0.0` |
| [openapi-operation](https://registry.docsloth.dev/components/openapi-operation.html) | @docsloth/openapi-operation | 1.0.0 | sha256:0d07bbe12d974160… | `docsloth component add @docsloth/openapi-operation@1.0.0` |
| [mermaid](https://registry.docsloth.dev/components/mermaid.html) | @docsloth/mermaid | 1.0.0 | sha256:96b5e8ca9f6f9073… | `docsloth component add @docsloth/mermaid@1.0.0` |
| [code-group](https://registry.docsloth.dev/components/code-group.html) | @docsloth/code-group | 1.0.0 | sha256:eb5f37eae33a615a… | `docsloth component add @docsloth/code-group@1.0.0` |
| [versioned-content](https://registry.docsloth.dev/components/versioned-content.html) | @docsloth/versioned-content | 1.0.0 | sha256:1e23f883a5debc8a… | `docsloth component add @docsloth/versioned-content@1.0.0` |

Machine metadata: every entry is served as JSON under [/api/v1](https://registry.docsloth.dev/api/v1/index.json); per-entry metadata and version resolution live at `/api/v1/components/<name>.json`.

## Other categories

Category membership is derived from the single catalog read by the generator; an empty category means the catalog has no matching entry today.

| Category | Route | Entries | Status |
| --- | --- | --- | --- |
| [Components](https://registry.docsloth.dev/components) | [/components](https://registry.docsloth.dev/components) | 57 | populated |
| [Blocks](https://registry.docsloth.dev/blocks) | [/blocks](https://registry.docsloth.dev/blocks) | 57 | populated |
| [Templates](https://registry.docsloth.dev/templates) | [/templates](https://registry.docsloth.dev/templates) | 0 | roadmap |
| [Themes](https://registry.docsloth.dev/themes) | [/themes](https://registry.docsloth.dev/themes) | 0 | roadmap |
| [Adapters](https://registry.docsloth.dev/adapters) | [/adapters](https://registry.docsloth.dev/adapters) | 0 | roadmap |
| [Recipes](https://registry.docsloth.dev/recipes) | [/recipes](https://registry.docsloth.dev/recipes) | 0 | roadmap |


---

# Templates

Registry category `/templates` — starter page skeletons assembled from catalog blocks.

| Field | Value |
| --- | --- |
| Route | [/templates](https://registry.docsloth.dev/templates) |
| Catalog entries | 0 |
| Status | roadmap — no entries yet (honest empty state) |
| Source of truth | packages/contracts/component-catalog.json |

## Empty by design

The catalog has no template entry and the package format has no template kind yet; templates are a roadmap category. A template appears here once it is registered as a catalog entry.

This page is generated from the catalog: when a matching entry is registered, the listing replaces this empty state automatically. No placeholder entry is rendered because a placeholder would be a listing that does not exist.

## How an entry gets here

```sh
docsloth component build --dir ./package
docsloth component publish --dir ./package --registry https://registry.docsloth.dev [--token "$DOCSLOTH_TOKEN"]
```

The publishing contract is documented at [/publish](https://registry.docsloth.dev/publish) and served machine-readable at [/api/v1/publish.json](https://registry.docsloth.dev/api/v1/publish.json).

## Other categories

Category membership is derived from the single catalog read by the generator; an empty category means the catalog has no matching entry today.

| Category | Route | Entries | Status |
| --- | --- | --- | --- |
| [Components](https://registry.docsloth.dev/components) | [/components](https://registry.docsloth.dev/components) | 57 | populated |
| [Blocks](https://registry.docsloth.dev/blocks) | [/blocks](https://registry.docsloth.dev/blocks) | 57 | populated |
| [Templates](https://registry.docsloth.dev/templates) | [/templates](https://registry.docsloth.dev/templates) | 0 | roadmap |
| [Themes](https://registry.docsloth.dev/themes) | [/themes](https://registry.docsloth.dev/themes) | 0 | roadmap |
| [Adapters](https://registry.docsloth.dev/adapters) | [/adapters](https://registry.docsloth.dev/adapters) | 0 | roadmap |
| [Recipes](https://registry.docsloth.dev/recipes) | [/recipes](https://registry.docsloth.dev/recipes) | 0 | roadmap |


---

# Themes

Registry category `/themes` — token and stylesheet packages (kind: theme).

| Field | Value |
| --- | --- |
| Route | [/themes](https://registry.docsloth.dev/themes) |
| Catalog entries | 0 |
| Status | roadmap — no entries yet (honest empty state) |
| Source of truth | packages/contracts/component-catalog.json |

## Empty by design

The package format accepts kind: theme, but no theme package is registered in the catalog. First-party token work ships as @docsloth/theme-tokens in this repository and is not a catalog entry.

This page is generated from the catalog: when a matching entry is registered, the listing replaces this empty state automatically. No placeholder entry is rendered because a placeholder would be a listing that does not exist.

## How an entry gets here

```sh
docsloth component build --dir ./package
docsloth component publish --dir ./package --registry https://registry.docsloth.dev [--token "$DOCSLOTH_TOKEN"]
```

The publishing contract is documented at [/publish](https://registry.docsloth.dev/publish) and served machine-readable at [/api/v1/publish.json](https://registry.docsloth.dev/api/v1/publish.json).

## Other categories

Category membership is derived from the single catalog read by the generator; an empty category means the catalog has no matching entry today.

| Category | Route | Entries | Status |
| --- | --- | --- | --- |
| [Components](https://registry.docsloth.dev/components) | [/components](https://registry.docsloth.dev/components) | 57 | populated |
| [Blocks](https://registry.docsloth.dev/blocks) | [/blocks](https://registry.docsloth.dev/blocks) | 57 | populated |
| [Templates](https://registry.docsloth.dev/templates) | [/templates](https://registry.docsloth.dev/templates) | 0 | roadmap |
| [Themes](https://registry.docsloth.dev/themes) | [/themes](https://registry.docsloth.dev/themes) | 0 | roadmap |
| [Adapters](https://registry.docsloth.dev/adapters) | [/adapters](https://registry.docsloth.dev/adapters) | 0 | roadmap |
| [Recipes](https://registry.docsloth.dev/recipes) | [/recipes](https://registry.docsloth.dev/recipes) | 0 | roadmap |


---

# Adapters

Registry category `/adapters` — format projections (kind: adapter), such as framework importers.

| Field | Value |
| --- | --- |
| Route | [/adapters](https://registry.docsloth.dev/adapters) |
| Catalog entries | 0 |
| Status | roadmap — no entries yet (honest empty state) |
| Source of truth | packages/contracts/component-catalog.json |

## Empty by design

The package format accepts kind: adapter; this repository ships @docsloth/adapters-docusaurus and @docsloth/adapters-mkdocs, but neither is registered in the catalog yet, so this category is empty.

This page is generated from the catalog: when a matching entry is registered, the listing replaces this empty state automatically. No placeholder entry is rendered because a placeholder would be a listing that does not exist.

## How an entry gets here

```sh
docsloth component build --dir ./package
docsloth component publish --dir ./package --registry https://registry.docsloth.dev [--token "$DOCSLOTH_TOKEN"]
```

The publishing contract is documented at [/publish](https://registry.docsloth.dev/publish) and served machine-readable at [/api/v1/publish.json](https://registry.docsloth.dev/api/v1/publish.json).

## Other categories

Category membership is derived from the single catalog read by the generator; an empty category means the catalog has no matching entry today.

| Category | Route | Entries | Status |
| --- | --- | --- | --- |
| [Components](https://registry.docsloth.dev/components) | [/components](https://registry.docsloth.dev/components) | 57 | populated |
| [Blocks](https://registry.docsloth.dev/blocks) | [/blocks](https://registry.docsloth.dev/blocks) | 57 | populated |
| [Templates](https://registry.docsloth.dev/templates) | [/templates](https://registry.docsloth.dev/templates) | 0 | roadmap |
| [Themes](https://registry.docsloth.dev/themes) | [/themes](https://registry.docsloth.dev/themes) | 0 | roadmap |
| [Adapters](https://registry.docsloth.dev/adapters) | [/adapters](https://registry.docsloth.dev/adapters) | 0 | roadmap |
| [Recipes](https://registry.docsloth.dev/recipes) | [/recipes](https://registry.docsloth.dev/recipes) | 0 | roadmap |


---

# Recipes

Registry category `/recipes` — composed how-to entries that combine catalog components.

| Field | Value |
| --- | --- |
| Route | [/recipes](https://registry.docsloth.dev/recipes) |
| Catalog entries | 0 |
| Status | roadmap — no entries yet (honest empty state) |
| Source of truth | packages/contracts/component-catalog.json |

## Empty by design

No recipe entry or recipe contract exists yet; recipes are a roadmap category and are registered in the catalog before they appear here.

This page is generated from the catalog: when a matching entry is registered, the listing replaces this empty state automatically. No placeholder entry is rendered because a placeholder would be a listing that does not exist.

## How an entry gets here

```sh
docsloth component build --dir ./package
docsloth component publish --dir ./package --registry https://registry.docsloth.dev [--token "$DOCSLOTH_TOKEN"]
```

The publishing contract is documented at [/publish](https://registry.docsloth.dev/publish) and served machine-readable at [/api/v1/publish.json](https://registry.docsloth.dev/api/v1/publish.json).

## Other categories

Category membership is derived from the single catalog read by the generator; an empty category means the catalog has no matching entry today.

| Category | Route | Entries | Status |
| --- | --- | --- | --- |
| [Components](https://registry.docsloth.dev/components) | [/components](https://registry.docsloth.dev/components) | 57 | populated |
| [Blocks](https://registry.docsloth.dev/blocks) | [/blocks](https://registry.docsloth.dev/blocks) | 57 | populated |
| [Templates](https://registry.docsloth.dev/templates) | [/templates](https://registry.docsloth.dev/templates) | 0 | roadmap |
| [Themes](https://registry.docsloth.dev/themes) | [/themes](https://registry.docsloth.dev/themes) | 0 | roadmap |
| [Adapters](https://registry.docsloth.dev/adapters) | [/adapters](https://registry.docsloth.dev/adapters) | 0 | roadmap |
| [Recipes](https://registry.docsloth.dev/recipes) | [/recipes](https://registry.docsloth.dev/recipes) | 0 | roadmap |


---

# Publish a component

How a package enters the registry: build a declarative package from source, publish it to a registry, and read it back from the catalog. The package format is the same one every catalog entry uses.

## The package contract

A package is a directory with a manifest (`component-package.json`), a payload and a JSON Schema for its props. `kind: block` packages are declarative document-IR content; nothing in a package executes on the host.

| kind | what it ships | status |
| --- | --- | --- |
| `block` | declarative document-IR specs, prop schemas, tokens, READMEs | 57 entries in the current catalog |
| `theme` | tokens and stylesheets | accepted by the format; no catalog entry yet |
| `adapter` | format projections, such as framework importers | accepted by the format; no catalog entry yet |
| `plugin` | third-party executable code | refused until a host sandbox with explicit capability grants exists |

## Build and publish

```sh
docsloth component build --dir ./package [--out ./dist]
```

```sh
docsloth component publish --dir ./package --registry https://registry.docsloth.dev --token "$DOCSLOTH_TOKEN"
```

A directory registry works the same way without a token: `docsloth component publish --dir ./package --registry ./registry` writes `index.json` and `packages/<name>/<version>/{manifest.json,files/…}`.

## HTTP publishing contract

| Field | Value |
| --- | --- |
| Method and path | `POST /v1/packages` |
| Authorization | `Bearer <token>` (from `--token` or `DOCSLOTH_TOKEN`); the token is never stored in the manifest, the registry or stdout |
| Body | `{ "manifest": { … }, "files": { "<path>": "<base64>" } }` |
| Success | `2xx { "ok": true, "digest": "sha256:…", "unchanged": true\|false }` |
| Refusal | `409` (or any non-2xx) when a name+version is republished with different bytes (`DSL1705`); an identical republish is a no-op |

The machine-readable contract is [/api/v1/publish.json](https://registry.docsloth.dev/api/v1/publish.json). Publishing auth and the hosted write path are cloud-side (owner / registry team); this static site documents the contract and does not accept publishes.

## What this registry serves

| Surface | Path | What it carries |
| --- | --- | --- |
| Search index | [/api/v1/search.json](https://registry.docsloth.dev/api/v1/search.json) | every catalog entry with its description, trust class, status, tools, URLs and install ref |
| Catalog | [/api/v1/catalog.json](https://registry.docsloth.dev/api/v1/catalog.json) | the same JSON as /catalog.json (one derivation, two routes) |
| Component metadata | `/api/v1/components/<name>.json` | one entry plus its version resolution |
| Version resolution | [/api/v1/versions.json](https://registry.docsloth.dev/api/v1/versions.json) | 57 entries; 57 carry a built package version and digest, 0 keep the catalog placeholder |
| Publishing contract | [/api/v1/publish.json](https://registry.docsloth.dev/api/v1/publish.json) | the POST /v1/packages contract, immutability rules and package kinds |
| Agent index | [/llms.txt](https://registry.docsloth.dev/llms.txt) | the human/agent table of contents for every page |

## Honest limits

The registry site is static: the API endpoints are pre-rendered files generated from `packages/contracts/component-catalog.json`, there is no request-time database and no query-time search service — clients filter the search index themselves. Version resolution reports the versions present in this generated catalog; a hosted registry resolves `latest` across all published versions.

Index signatures, yank/revoke and publisher identity are registry-operator concerns and are out of scope here; see `docs/MARKET_FLOW.md` for the full chain and the failure codes.


---

# prose

Readable structured narrative

| Field | Value |
| --- | --- |
| Trust class | pure |
| Implementation status | implemented_native |
| Renderer | native block |
| Key prop (production schema) | markdown |
| Key prop (protocol fixture) | text |
| Tools | none |
| Package version | 1.0.0 |
| Package digest | sha256:d4b0bbe677092b9f3f18da834e52d00da0e036a88f98875af0f69040fbc6d21e |

## Install

```sh
docsloth component add @docsloth/prose@1.0.0
```

Live package: sha256:d4b0bbe677092b9f3f18da834e52d00da0e036a88f98875af0f69040fbc6d21e with 2 file digest(s); the catalog entry is generated from the built package, not a placeholder.

## Props

The prop schema is normative in `packages/contracts/component-props/prose.schema.json`.

| Prop | Type | Required | Constraints |
| --- | --- | --- | --- |
| `title` | string | no | maxLength: 160 |
| `markdown` | string | yes | maxLength: 200000 |
| `source` | object | no | additionalProperties: false |
| `source.publication_id` | string | yes | format: uuid |
| `source.fact_ids` | array<string> | yes |  |
| `source.evidence_ids` | array<string> | yes |  |

Example props generated from this schema:

```json
{
  "title": "example-title",
  "markdown": "example-markdown",
  "source": {
    "publication_id": "00000000-0000-4000-8000-000000000000",
    "fact_ids": [
      "00000000-0000-4000-8000-000000000000"
    ],
    "evidence_ids": [
      "00000000-0000-4000-8000-000000000000"
    ]
  }
}
```

Required props: markdown.

## Example

Example document IR (the block the renderer consumes):

```json
{
  "type": "prose",
  "props": {
    "text": "Readable structured narrative rendered from the document IR."
  }
}
```

Renderer HTML (entities decoded and wrapped for display):

```html
<div class="ds-prose">Readable structured narrative rendered from the document IR.</div>
```

Preview (interface-only; the markup above is the same output):

The renderer resolves this component as a native block; the preview above is its real HTML output, and Markdown parity for native blocks is covered by the renderer test suite.

## Specification

Generated from `packages/contracts/component-specs/prose.md`.

### Contract

Production props are normative in `../contracts/component-props/prose.schema.json`. The corresponding `component-fixtures` manifest is only a minimal protocol fixture; use the production props schema when building the published package. The packaged artifact ships exactly its generated `component-package.json` manifest plus `props.schema.json` (the production props schema, copied byte-for-byte) and `spec.md` (this spec, copied byte-for-byte); it contains no executable payload, fallback implementation, Storybook, test suite, SSR harness or README. Rendering behavior and the acceptance cases below belong to the renderer and the repository tests, not to the package. Installation pins the package version and the digest of every shipped byte.

### Intended behavior

Render sanitized semantic rich text with stable heading anchors; arbitrary raw HTML is off.

### Failure and fallback

Malformed nodes reject a patch rather than emit unsafe HTML.

### Required acceptance cases

Heading order, links, source badges and equivalent plain Markdown. Also test empty data, loading, denied access, browser without JS, mobile 360px, keyboard navigation, dark mode and an explicit constrained agent tool call. The server independently authorizes capability requests; a package manifest cannot grant authority.

### Data and maintenance

Data bindings resolve from a specific publication/release vector and permitted fact/evidence graph. Configuration edits create versioned component patches. Update invalidation uses dependency IDs, never indiscriminate whole-page regeneration. Human-owned props survive automatic updates unless invalidated with an explicit conflict. Missing optional resources leave an honest inert/readable fallback, not a broken page or fake success.

### Cost and tools

Pure/local interaction must never invoke a model by accident. Any model, remote query or executor call must reserve approved budget before dispatch. Public visitors do not inherit owner resources. The component may call only named tools in its signed manifest with valid typed inputs. A cancelled job stops polling and closes resources. No component gets platform administration, raw credentials or an unlimited execution loop.

## Package manifest

Protocol fixture: `packages/contracts/component-fixtures/prose.json`.

| Field | Value |
| --- | --- |
| Name | @docsloth/prose |
| Version | 1.0.0 |
| Protocol | 1.x |
| License | Apache-2.0 |
| Runtime | react |
| Entry | dist/index.js |
| Recording policy | masked |
| Fallback | html, markdown, json |
| Network hosts | none |
| Production write | no |
| Max runtime seconds | 0 |
| Integrity | all zeros (protocol fixture placeholder) |

## Sources

| Source | Path |
| --- | --- |
| Component page | https://registry.docsloth.dev/components/prose.html |
| Markdown twin | https://registry.docsloth.dev/docs/prose.md |
| LLM index | https://registry.docsloth.dev/llms.txt |
| Specification | packages/contracts/component-specs/prose.md |
| Prop schema | packages/contracts/component-props/prose.schema.json |
| Protocol fixture | packages/contracts/component-fixtures/prose.json |
| Catalog | packages/contracts/component-catalog.json |


---

# callout

Important contextual warnings

| Field | Value |
| --- | --- |
| Trust class | pure |
| Implementation status | implemented_native |
| Renderer | native block |
| Key prop (production schema) | tone |
| Key prop (protocol fixture) | text |
| Tools | none |
| Package version | 1.0.0 |
| Package digest | sha256:584792d30684ff49b50b69c8535eab21256c68c9a43ce20bff7cd02f4122235b |

## Install

```sh
docsloth component add @docsloth/callout@1.0.0
```

Live package: sha256:584792d30684ff49b50b69c8535eab21256c68c9a43ce20bff7cd02f4122235b with 2 file digest(s); the catalog entry is generated from the built package, not a placeholder.

## Props

The prop schema is normative in `packages/contracts/component-props/callout.schema.json`.

| Prop | Type | Required | Constraints |
| --- | --- | --- | --- |
| `title` | string | no | maxLength: 160 |
| `tone` | "note" \| "warning" \| "danger" \| "success" | yes |  |
| `body` | string | yes | maxLength: 20000 |
| `dismissible` | boolean | no |  |

Example props generated from this schema:

```json
{
  "title": "example-title",
  "tone": "note",
  "body": "example-body",
  "dismissible": true
}
```

Required props: tone, body.

## Example

Example document IR (the block the renderer consumes):

```json
{
  "type": "callout",
  "props": {
    "text": "Important contextual warning kept visible to agents and readers.",
    "tone": "info"
  }
}
```

Renderer HTML (entities decoded and wrapped for display):

```html
<aside class="ds-callout" data-tone="info">Important contextual warning kept visible to agents and readers.</aside>
```

Preview (interface-only; the markup above is the same output):

The renderer resolves this component as a native block; the preview above is its real HTML output, and Markdown parity for native blocks is covered by the renderer test suite.

## Specification

Generated from `packages/contracts/component-specs/callout.md`.

### Contract

Production props are normative in `../contracts/component-props/callout.schema.json`. The corresponding `component-fixtures` manifest is only a minimal protocol fixture; use the production props schema when building the published package. The packaged artifact ships exactly its generated `component-package.json` manifest plus `props.schema.json` (the production props schema, copied byte-for-byte) and `spec.md` (this spec, copied byte-for-byte); it contains no executable payload, fallback implementation, Storybook, test suite, SSR harness or README. Rendering behavior and the acceptance cases below belong to the renderer and the repository tests, not to the package. Installation pins the package version and the digest of every shipped byte.

### Intended behavior

The React component renders title, body and an explicit tone label, so meaning does not depend on color. Warning and danger notices are always persistent: the current schema does not carry required-step context. Note and success callouts may be dismissed only when `dismissible: true`. Dismissal is local to the current content; changing title, body, tone or effective permission resets it. No network, model or executor call occurs.

### Failure and fallback

Unknown tones use Note. Missing or malformed body has a readable content-unavailable fallback. Author text is escaped. Server output keeps the content visible and omits dismissal controls until hydration, so no-JS readers see the complete notice. The native document renderer remains a static aside; dismissal is provided by the hydrated React component.

### Required acceptance cases

Keyboard dismissal only when permitted; danger remains visible. Also test empty data, loading, denied access, browser without JS, mobile 360px, keyboard navigation, dark mode and an explicit constrained agent tool call. The server independently authorizes capability requests; a package manifest cannot grant authority.

### Data and maintenance

Data bindings resolve from a specific publication/release vector and permitted fact/evidence graph. Configuration edits create versioned component patches. Update invalidation uses dependency IDs, never indiscriminate whole-page regeneration. Human-owned props survive automatic updates unless invalidated with an explicit conflict. Missing optional resources leave an honest inert/readable fallback, not a broken page or fake success.

### Cost and tools

Pure/local interaction must never invoke a model by accident. Any model, remote query or executor call must reserve approved budget before dispatch. Public visitors do not inherit owner resources. The component may call only named tools in its signed manifest with valid typed inputs. A cancelled job stops polling and closes resources. No component gets platform administration, raw credentials or an unlimited execution loop.

## Package manifest

Protocol fixture: `packages/contracts/component-fixtures/callout.json`.

| Field | Value |
| --- | --- |
| Name | @docsloth/callout |
| Version | 1.0.0 |
| Protocol | 1.x |
| License | Apache-2.0 |
| Runtime | react |
| Entry | dist/index.js |
| Recording policy | masked |
| Fallback | html, markdown, json |
| Network hosts | none |
| Production write | no |
| Max runtime seconds | 0 |
| Integrity | all zeros (protocol fixture placeholder) |

## Sources

| Source | Path |
| --- | --- |
| Component page | https://registry.docsloth.dev/components/callout.html |
| Markdown twin | https://registry.docsloth.dev/docs/callout.md |
| LLM index | https://registry.docsloth.dev/llms.txt |
| Specification | packages/contracts/component-specs/callout.md |
| Prop schema | packages/contracts/component-props/callout.schema.json |
| Protocol fixture | packages/contracts/component-fixtures/callout.json |
| Catalog | packages/contracts/component-catalog.json |


---

# tabs

Switch related presentations

| Field | Value |
| --- | --- |
| Trust class | interactive |
| Implementation status | implemented_native |
| Renderer | native block |
| Key prop (production schema) | tabs |
| Key prop (protocol fixture) | activeTab |
| Tools | select_tab |
| Package version | 1.0.0 |
| Package digest | sha256:2b5dfd26ede0e42e1f49f55a30405ae643e5dc18fe13460286d0ad1b7f2bcc22 |

## Install

```sh
docsloth component add @docsloth/tabs@1.0.0
```

Live package: sha256:2b5dfd26ede0e42e1f49f55a30405ae643e5dc18fe13460286d0ad1b7f2bcc22 with 2 file digest(s); the catalog entry is generated from the built package, not a placeholder.

## Props

The prop schema is normative in `packages/contracts/component-props/tabs.schema.json`.

| Prop | Type | Required | Constraints |
| --- | --- | --- | --- |
| `title` | string | no | maxLength: 160 |
| `tabs` | array<object> | yes | minItems: 1 |
| `default_id` | string | yes | maxLength: 256 |
| `sync_key` | string | no | maxLength: 256 |

Example props generated from this schema:

```json
{
  "title": "example-title",
  "tabs": [
    {
      "id": "example-id",
      "label": "example-label",
      "block_ids": [
        "00000000-0000-4000-8000-000000000000"
      ]
    }
  ],
  "default_id": "example-default_id",
  "sync_key": "example-sync_key"
}
```

Required props: tabs, default_id.

## Example

Example document IR (the block the renderer consumes):

```json
{
  "type": "tabs",
  "props": {
    "title": "Install",
    "active": 0
  },
  "children": [
    {
      "type": "prose",
      "props": {
        "label": "npm",
        "text": "npm add @docsloth/renderer"
      }
    },
    {
      "type": "code",
      "props": {
        "label": "pnpm",
        "language": "bash",
        "code": "pnpm add @docsloth/renderer"
      }
    }
  ]
}
```

Renderer HTML (entities decoded and wrapped for display):

```html
<div class="ds-tabs" data-component="tabs">
<div class="ds-tablist" role="tablist" aria-label="Install">
<button type="button" class="ds-tab" role="tab" id="b-tab-0" aria-controls="b-panel-0" aria-selected="true" tabindex="0">npm</button>
<button type="button" class="ds-tab" role="tab" id="b-tab-1" aria-controls="b-panel-1" aria-selected="false" tabindex="-1">pnpm</button>
</div>
<div class="ds-tabpanels">
<div class="ds-tabpanel" role="tabpanel" id="b-panel-0" aria-labelledby="b-tab-0" tabindex="0">
<div class="ds-prose">npm add @docsloth/renderer</div>
</div>
<div class="ds-tabpanel" role="tabpanel" id="b-panel-1" aria-labelledby="b-tab-1" tabindex="0">
<pre class="ds-code" data-lang="bash">
<code>pnpm add @docsloth/renderer</code>
</pre>
</div>
</div>
</div>
```

Preview (interface-only; the markup above is the same output):

The renderer resolves this component as a native block; the preview above is its real HTML output, and Markdown parity for native blocks is covered by the renderer test suite.

## Specification

Generated from `packages/contracts/component-specs/tabs.md`.

### Contract

Production props are normative in `../contracts/component-props/tabs.schema.json`. The corresponding `component-fixtures` manifest is only a minimal protocol fixture; use the production props schema when building the published package. The packaged artifact ships exactly its generated `component-package.json` manifest plus `props.schema.json` (the production props schema, copied byte-for-byte) and `spec.md` (this spec, copied byte-for-byte); it contains no executable payload, fallback implementation, Storybook, test suite, SSR harness or README. Rendering behavior and the acceptance cases below belong to the renderer and the repository tests, not to the package. Installation pins the package version and the digest of every shipped byte.

### Intended behavior

ARIA tabs, arrow keys, retain each panel in readable fallback; sync language preference within version.

### React host integration

The official React `Tabs` uses production `tabs`, `default_id`, `title` and `sync_key` props. It selects by ID across reordering; removing a selected tab restores the declared default (or the first tab when that default is absent). Arrow keys wrap, Home/End move to either end, and each tab is linked to its panel through ARIA attributes, following the [WAI-ARIA tabs pattern](https://www.w3.org/WAI/ARIA/apg/patterns/tabs/).

A host supplies already-authorized, rendered release blocks with the exported `ComponentContentProvider` from `@docsloth/official-components/host`. Its `blocks` prop is a `ReadonlyMap<string, ReactNode>` and `releaseId` identifies the publication release. Tabs resolve only their declared `block_ids` from that map; missing blocks show “Content unavailable.” No block fetch or tool call occurs on selection. The JSON component props remain serializable; the provider is a React host API, separate from those props.

Tabs sharing a `sync_key` within one provider share the selected ID. Preferences stay in memory, are isolated from other providers, and reset when `releaseId` changes. The host must change that ID when switching releases. All panels render visibly on the server for readable no-JS fallback; hydration hides inactive panels while keeping their content mounted. This provider does not automatically wire the separate native document renderer or connected executor tools.

```tsx
<ComponentContentProvider releaseId={release.id} blocks={authorizedRenderedBlocks}>
  <Tabs tabs={tabDefinitions} default_id="npm" sync_key="package-manager" />
</ComponentContentProvider>
```

### Failure and fallback

Unknown selected ID resets to declared default, not arbitrary new tab.

### Required acceptance cases

No request or write occurs merely by selecting a tab. Also test empty data, loading, denied access, browser without JS, mobile 360px, keyboard navigation, dark mode and an explicit constrained agent tool call. The server independently authorizes capability requests; a package manifest cannot grant authority.

### Data and maintenance

Data bindings resolve from a specific publication/release vector and permitted fact/evidence graph. Configuration edits create versioned component patches. Update invalidation uses dependency IDs, never indiscriminate whole-page regeneration. Human-owned props survive automatic updates unless invalidated with an explicit conflict. Missing optional resources leave an honest inert/readable fallback, not a broken page or fake success.

### Cost and tools

Pure/local interaction must never invoke a model by accident. Any model, remote query or executor call must reserve approved budget before dispatch. Public visitors do not inherit owner resources. The component may call only named tools in its signed manifest with valid typed inputs. A cancelled job stops polling and closes resources. No component gets platform administration, raw credentials or an unlimited execution loop.

### Native renderer block

`packages/renderer` renders a `tabs` block from the document IR: children carry `props.label` and the renderer emits an accessible `role="tablist"` whose `role="tab"` buttons wire `aria-controls` to matching `role="tabpanel"` panels. Production props for a packaged instance remain normative in `../contracts/component-props/tabs.schema.json`.

#### Native block props

| prop | type | required | behaviour |
| --- | --- | --- | --- |
| `title` | string | no | Accessible name of the tablist (`aria-label`, default `Tabs`). |
| `active` | integer | no | Zero-based index selected by default; unknown values degrade to the first tab. |
| `activeTab` | string | no | Label or `props.id` of the selected tab; unknown ids degrade to the first tab. |
| `children` | DocBlock[] | yes | One panel per child; each child needs a non-empty `props.label`. A missing label degrades the whole block to the labelled fallback. |

Panels stay in the DOM (no `hidden`) so no-JS and agent readers see every presentation. The tab buttons are content labels, not chrome, so they are not marked `data-markdown-ignore`; Markdown flattens the block to `### <label>` subsections.

#### Example

```json
{
  "type": "tabs",
  "props": { "title": "Install", "active": 0 },
  "children": [
    { "type": "prose", "props": { "label": "npm", "text": "npm add @docsloth/renderer" } },
    { "type": "code", "props": { "label": "pnpm", "language": "bash", "code": "pnpm add @docsloth/renderer" } }
  ]
}
```

## Package manifest

Protocol fixture: `packages/contracts/component-fixtures/tabs.json`.

| Field | Value |
| --- | --- |
| Name | @docsloth/tabs |
| Version | 1.0.0 |
| Protocol | 1.x |
| License | Apache-2.0 |
| Runtime | react |
| Entry | dist/index.js |
| Recording policy | masked |
| Fallback | html, markdown, json |
| Network hosts | none |
| Production write | no |
| Max runtime seconds | 0 |
| Integrity | all zeros (protocol fixture placeholder) |

| Tool | Effect | Confirmation | Input |
| --- | --- | --- | --- |
| select_tab | read | no | value |

## Sources

| Source | Path |
| --- | --- |
| Component page | https://registry.docsloth.dev/components/tabs.html |
| Markdown twin | https://registry.docsloth.dev/docs/tabs.md |
| LLM index | https://registry.docsloth.dev/llms.txt |
| Specification | packages/contracts/component-specs/tabs.md |
| Prop schema | packages/contracts/component-props/tabs.schema.json |
| Protocol fixture | packages/contracts/component-fixtures/tabs.json |
| Catalog | packages/contracts/component-catalog.json |


---

# table

Filterable structured reference

| Field | Value |
| --- | --- |
| Trust class | interactive |
| Implementation status | implemented_native |
| Renderer | native block |
| Key prop (production schema) | columns |
| Key prop (protocol fixture) | rows |
| Tools | filter_rows |
| Package version | 1.0.0 |
| Package digest | sha256:9eb3021214ce7a962dd1650b424855f6f4467a94bfc42f929cb7a4dc82080094 |

## Install

```sh
docsloth component add @docsloth/table@1.0.0
```

Live package: sha256:9eb3021214ce7a962dd1650b424855f6f4467a94bfc42f929cb7a4dc82080094 with 2 file digest(s); the catalog entry is generated from the built package, not a placeholder.

## Props

The prop schema is normative in `packages/contracts/component-props/table.schema.json`.

| Prop | Type | Required | Constraints |
| --- | --- | --- | --- |
| `title` | string | no | maxLength: 160 |
| `columns` | array<object> | yes | minItems: 1 |
| `rows` | array<object> | yes |  |
| `filterable` | boolean | no |  |

Example props generated from this schema:

```json
{
  "title": "example-title",
  "columns": [
    {
      "key": "example-key",
      "label": "example-label",
      "sortable": true
    }
  ],
  "rows": [
    {
      "key": "example-key",
      "cells": [
        "example-cells"
      ]
    }
  ],
  "filterable": true
}
```

Required props: columns, rows.

## Example

Example document IR (the block the renderer consumes):

```json
{
  "type": "table",
  "props": {
    "rows": [
      [
        "component",
        "trust class"
      ],
      [
        "prose",
        "pure"
      ],
      [
        "tabs",
        "interactive"
      ]
    ]
  }
}
```

Renderer HTML (entities decoded and wrapped for display):

```html
<table class="ds-table">
<tr>
<td>component</td>
<td>trust class</td>
</tr>
<tr>
<td>prose</td>
<td>pure</td>
</tr>
<tr>
<td>tabs</td>
<td>interactive</td>
</tr>
</table>
```

Preview (interface-only; the markup above is the same output):

The renderer resolves this component as a native block; the preview above is its real HTML output, and Markdown parity for native blocks is covered by the renderer test suite.

## Specification

Generated from `packages/contracts/component-specs/table.md`.

### Contract

Production props are normative in `../contracts/component-props/table.schema.json`. The corresponding `component-fixtures` manifest is only a minimal protocol fixture; use the production props schema when building the published package. The packaged artifact ships exactly its generated `component-package.json` manifest plus `props.schema.json` (the production props schema, copied byte-for-byte) and `spec.md` (this spec, copied byte-for-byte); it contains no executable payload, fallback implementation, Storybook, test suite, SSR harness or README. Rendering behavior and the acceptance cases below belong to the renderer and the repository tests, not to the package. Installation pins the package version and the digest of every shipped byte.

### Intended behavior

Accessible header cells; stable sort/filter and CSV export only audience-approved cells.

#### Official React implementation

Production `{ key, cells }` rows render one cell under each declared column. Row keys and surplus cells are not displayed or searched. Array rows remain accepted for older hosts. `title` provides a caption; `filterable: false` removes filtering. Declared sortable columns expose ascending and descending natural text order through header buttons and `aria-sort`, retaining source order for ties. Filtering and sorting reset the initial 200-row view; **Show more rows** reveals each following group of 200. A live status announces the visible count or empty result.

These interactions are local and issue no capability or network requests. CSV export uses all filtered rows in the current sort order, including rows beyond the incremental display, and only the visible columns. The UTF-8 file includes a BOM, quoted fields and CRLF row separators; quotes inside fields are doubled. Formula-like values (including header labels, leading control/format characters and full-width formula markers) receive a visible `Text: ` prefix. This deliberately changes those exported values rather than relying on escapes that spreadsheets may remove when re-saving ([CSV injection considerations](https://owasp.org/www-community/attacks/CSV_Injection)). The on-page note describes this behavior. Exports larger than 10 MiB are refused before creating a download; filtering can reduce the file. Temporary object URLs are revoked after use, and unsupported browser download APIs produce a visible error. Server-bound pagination remains outside this React implementation. Without JavaScript, its complete supplied data remains readable under plain column headings. Filtering, sorting and incremental display controls appear only after hydration; hydrated pages start with 200 rows. Server output includes all rows up to the production schema's 5000-row limit, so its size grows with the authorized data. This is a readable fallback, not server pagination or virtualization.

### Failure and fallback

More than 5000 rows uses server pagination after explicit resource binding.

### Required acceptance cases

Empty filter status announced; sorting stable and numerical columns declared. Also test empty data, loading, denied access, browser without JS, mobile 360px, keyboard navigation, dark mode and an explicit constrained agent tool call. The server independently authorizes capability requests; a package manifest cannot grant authority.

### Data and maintenance

Data bindings resolve from a specific publication/release vector and permitted fact/evidence graph. Configuration edits create versioned component patches. Update invalidation uses dependency IDs, never indiscriminate whole-page regeneration. Human-owned props survive automatic updates unless invalidated with an explicit conflict. Missing optional resources leave an honest inert/readable fallback, not a broken page or fake success.

### Cost and tools

Pure/local interaction must never invoke a model by accident. Any model, remote query or executor call must reserve approved budget before dispatch. Public visitors do not inherit owner resources. The component may call only named tools in its signed manifest with valid typed inputs. A cancelled job stops polling and closes resources. No component gets platform administration, raw credentials or an unlimited execution loop.

## Package manifest

Protocol fixture: `packages/contracts/component-fixtures/table.json`.

| Field | Value |
| --- | --- |
| Name | @docsloth/table |
| Version | 1.0.0 |
| Protocol | 1.x |
| License | Apache-2.0 |
| Runtime | react |
| Entry | dist/index.js |
| Recording policy | masked |
| Fallback | html, markdown, json |
| Network hosts | none |
| Production write | no |
| Max runtime seconds | 0 |
| Integrity | all zeros (protocol fixture placeholder) |

| Tool | Effect | Confirmation | Input |
| --- | --- | --- | --- |
| filter_rows | read | no | value |

## Sources

| Source | Path |
| --- | --- |
| Component page | https://registry.docsloth.dev/components/table.html |
| Markdown twin | https://registry.docsloth.dev/docs/table.md |
| LLM index | https://registry.docsloth.dev/llms.txt |
| Specification | packages/contracts/component-specs/table.md |
| Prop schema | packages/contracts/component-props/table.schema.json |
| Protocol fixture | packages/contracts/component-fixtures/table.json |
| Catalog | packages/contracts/component-catalog.json |


---

# code

Syntax-highlighted copyable code

| Field | Value |
| --- | --- |
| Trust class | interactive |
| Implementation status | implemented_native |
| Renderer | native block |
| Key prop (production schema) | code |
| Key prop (protocol fixture) | code |
| Tools | copy, highlight |
| Package version | 1.0.0 |
| Package digest | sha256:f8b010a4d36aafdd2b86ee6d9e4c3a8091d44ce9a8e736cc7e0e64fb292dd620 |

## Install

```sh
docsloth component add @docsloth/code@1.0.0
```

Live package: sha256:f8b010a4d36aafdd2b86ee6d9e4c3a8091d44ce9a8e736cc7e0e64fb292dd620 with 2 file digest(s); the catalog entry is generated from the built package, not a placeholder.

## Props

The prop schema is normative in `packages/contracts/component-props/code.schema.json`.

| Prop | Type | Required | Constraints |
| --- | --- | --- | --- |
| `title` | string | no | maxLength: 160 |
| `code` | string | yes | maxLength: 200000 |
| `language` | string | yes | maxLength: 40 |
| `filename` | string | no | maxLength: 256 |
| `highlight_lines` | array<integer> | no |  |

Example props generated from this schema:

```json
{
  "title": "example-title",
  "code": "echo hello",
  "language": "example-language",
  "filename": "example-filename",
  "highlight_lines": [
    1
  ]
}
```

Required props: code, language.

## Example

Example document IR (the block the renderer consumes):

```json
{
  "type": "code",
  "props": {
    "code": "docsloth component add prose@1.0.0",
    "language": "sh"
  }
}
```

Renderer HTML (entities decoded and wrapped for display):

```html
<pre class="ds-code" data-lang="sh">
<code>docsloth component add prose@1.0.0</code>
</pre>
```

Preview (interface-only; the markup above is the same output):

The renderer resolves this component as a native block; the preview above is its real HTML output, and Markdown parity for native blocks is covered by the renderer test suite.

## Specification

Generated from `packages/contracts/component-specs/code.md`.

### Contract

Production props are normative in `../contracts/component-props/code.schema.json`. The corresponding `component-fixtures` manifest is only a minimal protocol fixture; use the production props schema when building the published package. The packaged artifact ships exactly its generated `component-package.json` manifest plus `props.schema.json` (the production props schema, copied byte-for-byte) and `spec.md` (this spec, copied byte-for-byte); it contains no executable payload, fallback implementation, Storybook, test suite, SSR harness or README. Rendering behavior and the acceptance cases below belong to the renderer and the repository tests, not to the package. Installation pins the package version and the digest of every shipped byte.

### Intended behavior

Copy original source string, optional line highlights and filenames; tabs never alter actual sample meaning.

### Failure and fallback

Unknown lexer falls back to plain text.

### Required acceptance cases

Copy exact code including Unicode/newlines; no hidden tracking string. Also test empty data, loading, denied access, browser without JS, mobile 360px, keyboard navigation, dark mode and an explicit constrained agent tool call. The server independently authorizes capability requests; a package manifest cannot grant authority.

### Data and maintenance

Data bindings resolve from a specific publication/release vector and permitted fact/evidence graph. Configuration edits create versioned component patches. Update invalidation uses dependency IDs, never indiscriminate whole-page regeneration. Human-owned props survive automatic updates unless invalidated with an explicit conflict. Missing optional resources leave an honest inert/readable fallback, not a broken page or fake success.

### Cost and tools

Pure/local interaction must never invoke a model by accident. Any model, remote query or executor call must reserve approved budget before dispatch. Public visitors do not inherit owner resources. The component may call only named tools in its signed manifest with valid typed inputs. A cancelled job stops polling and closes resources. No component gets platform administration, raw credentials or an unlimited execution loop.

## Package manifest

Protocol fixture: `packages/contracts/component-fixtures/code.json`.

| Field | Value |
| --- | --- |
| Name | @docsloth/code |
| Version | 1.0.0 |
| Protocol | 1.x |
| License | Apache-2.0 |
| Runtime | react |
| Entry | dist/index.js |
| Recording policy | masked |
| Fallback | html, markdown, json |
| Network hosts | none |
| Production write | no |
| Max runtime seconds | 0 |
| Integrity | all zeros (protocol fixture placeholder) |

| Tool | Effect | Confirmation | Input |
| --- | --- | --- | --- |
| copy | read | no | value |
| highlight | read | no | value |

## Sources

| Source | Path |
| --- | --- |
| Component page | https://registry.docsloth.dev/components/code.html |
| Markdown twin | https://registry.docsloth.dev/docs/code.md |
| LLM index | https://registry.docsloth.dev/llms.txt |
| Specification | packages/contracts/component-specs/code.md |
| Prop schema | packages/contracts/component-props/code.schema.json |
| Protocol fixture | packages/contracts/component-fixtures/code.json |
| Catalog | packages/contracts/component-catalog.json |


---

# code-diff

Inspect a versioned example change

| Field | Value |
| --- | --- |
| Trust class | interactive |
| Implementation status | implemented_native |
| Renderer | native block |
| Key prop (production schema) | before |
| Key prop (protocol fixture) | before |
| Tools | select_hunk |
| Package version | 1.0.0 |
| Package digest | sha256:8c0bab13a03409784a6ad13234099f9f140b41deca0c21201a27d7428d66d19e |

## Install

```sh
docsloth component add @docsloth/code-diff@1.0.0
```

Live package: sha256:8c0bab13a03409784a6ad13234099f9f140b41deca0c21201a27d7428d66d19e with 2 file digest(s); the catalog entry is generated from the built package, not a placeholder.

## Props

The prop schema is normative in `packages/contracts/component-props/code-diff.schema.json`.

| Prop | Type | Required | Constraints |
| --- | --- | --- | --- |
| `title` | string | no | maxLength: 160 |
| `before` | string | yes | maxLength: 200000 |
| `after` | string | yes | maxLength: 200000 |
| `language` | string | yes |  |
| `from_version` | string | no |  |
| `to_version` | string | no |  |

Example props generated from this schema:

```json
{
  "title": "example-title",
  "before": "example-before",
  "after": "example-after",
  "language": "example-language",
  "from_version": "example-from_version",
  "to_version": "example-to_version"
}
```

Required props: before, after, language.

## Example

Example document IR (the block the renderer consumes):

```json
{
  "type": "code-diff",
  "props": {
    "title": "example-title",
    "before": "example-before",
    "after": "example-after",
    "language": "example-language",
    "from_version": "example-from_version",
    "to_version": "example-to_version"
  }
}
```

Renderer HTML (entities decoded and wrapped for display):

```html
<section class="ds-block ds-code-diff" data-component="code-diff" aria-labelledby="b-title">
<h3 class="ds-block-title" id="b-title">example-title</h3>
<p>Changes from <code>example-from_version</code> to <code>example-to_version</code>
</p>
<pre class="ds-diff" data-lang="example-language">
<code>
<del class="ds-diff-del">- example-before</del>
<ins class="ds-diff-ins">+ example-after</ins>
</code>
</pre>
</section>
```

Preview (interface-only; the markup above is the same output):

The renderer resolves this component as a native block; the preview above is its real HTML output, and Markdown parity for native blocks is covered by the renderer test suite.

## Specification

Generated from `packages/contracts/component-specs/code-diff.md`.

### Contract

Production props are normative in `../contracts/component-props/code-diff.schema.json`. The corresponding `component-fixtures` manifest is only a minimal protocol fixture; use the production props schema when building the published package. The packaged artifact ships exactly its generated `component-package.json` manifest plus `props.schema.json` (the production props schema, copied byte-for-byte) and `spec.md` (this spec, copied byte-for-byte); it contains no executable payload, fallback implementation, Storybook, test suite, SSR harness or README. Rendering behavior and the acceptance cases below belong to the renderer and the repository tests, not to the package. Installation pins the package version and the digest of every shipped byte.

### Intended behavior

Unified/split diff view with accessible insert/delete labels and read-only source.

### Failure and fallback

Large diff paginated; not silently truncated as complete.

### Current React behavior

Line alignment preserves unchanged prefixes and suffixes when lines are inserted or deleted. Removed and added lines have text labels and source line numbers; missing final newlines are marked. Hydrated controls select unified, split, before or after views and reveal changes in pages of 50. Native source disclosures retain both complete inputs without JavaScript, where all change hunks are also rendered. Source text is escaped and long lines scroll within panes. Alignment uses a bounded matrix of at most one million cells. Larger changed regions are grouped with a visible notice; both original source strings remain complete. Internal diff operations reconstruct both inputs exactly; no downloadable patch or execution capability is exposed. Authorization, loading and remote source retrieval remain host responsibilities.

### Required acceptance cases

Patch reconstructed after applying diff equals after text. Also test empty data, loading, denied access, browser without JS, mobile 360px, keyboard navigation, dark mode and an explicit constrained agent tool call. The server independently authorizes capability requests; a package manifest cannot grant authority.

### Data and maintenance

Data bindings resolve from a specific publication/release vector and permitted fact/evidence graph. Configuration edits create versioned component patches. Update invalidation uses dependency IDs, never indiscriminate whole-page regeneration. Human-owned props survive automatic updates unless invalidated with an explicit conflict. Missing optional resources leave an honest inert/readable fallback, not a broken page or fake success.

### Cost and tools

Pure/local interaction must never invoke a model by accident. Any model, remote query or executor call must reserve approved budget before dispatch. Public visitors do not inherit owner resources. The component may call only named tools in its signed manifest with valid typed inputs. A cancelled job stops polling and closes resources. No component gets platform administration, raw credentials or an unlimited execution loop.

## Package manifest

Protocol fixture: `packages/contracts/component-fixtures/code-diff.json`.

| Field | Value |
| --- | --- |
| Name | @docsloth/code-diff |
| Version | 1.0.0 |
| Protocol | 1.x |
| License | Apache-2.0 |
| Runtime | react |
| Entry | dist/index.js |
| Recording policy | masked |
| Fallback | html, markdown, json |
| Network hosts | none |
| Production write | no |
| Max runtime seconds | 0 |
| Integrity | all zeros (protocol fixture placeholder) |

| Tool | Effect | Confirmation | Input |
| --- | --- | --- | --- |
| select_hunk | read | no | value |

## Sources

| Source | Path |
| --- | --- |
| Component page | https://registry.docsloth.dev/components/code-diff.html |
| Markdown twin | https://registry.docsloth.dev/docs/code-diff.md |
| LLM index | https://registry.docsloth.dev/llms.txt |
| Specification | packages/contracts/component-specs/code-diff.md |
| Prop schema | packages/contracts/component-props/code-diff.schema.json |
| Protocol fixture | packages/contracts/component-fixtures/code-diff.json |
| Catalog | packages/contracts/component-catalog.json |


---

# live-code

Execute an example in an approved environment

| Field | Value |
| --- | --- |
| Trust class | connected |
| Implementation status | implemented_native |
| Renderer | native block |
| Key prop (production schema) | code |
| Key prop (protocol fixture) | code |
| Tools | run, cancel, reset |
| Package version | 1.0.0 |
| Package digest | sha256:337712c7adaa12651b91360682771ec891592494dad9678aceb296734bf90901 |

## Install

```sh
docsloth component add @docsloth/live-code@1.0.0
```

Live package: sha256:337712c7adaa12651b91360682771ec891592494dad9678aceb296734bf90901 with 2 file digest(s); the catalog entry is generated from the built package, not a placeholder.

## Props

The prop schema is normative in `packages/contracts/component-props/live-code.schema.json`.

| Prop | Type | Required | Constraints |
| --- | --- | --- | --- |
| `title` | string | no | maxLength: 160 |
| `code` | string | yes | maxLength: 200000 |
| `language` | string | yes | maxLength: 40 |
| `filename` | string | no | maxLength: 256 |
| `highlight_lines` | array<integer> | no |  |
| `files` | array<object> | no |  |
| `runtime` | "browser-js" \| "wasm-python" \| "remote-sandbox" | yes |  |
| `resource` | object | no | additionalProperties: false |
| `resource.resource_id` | string | yes | format: uuid |
| `resource.operation` | string | yes | maxLength: 160 |
| `resource.environment` | "test" \| "staging" \| "production" | yes |  |
| `timeout_seconds` | integer | yes |  |
| `max_output_bytes` | integer | yes |  |

Example props generated from this schema:

```json
{
  "title": "example-title",
  "code": "echo hello",
  "language": "example-language",
  "filename": "example-filename",
  "highlight_lines": [
    1
  ],
  "files": [
    {
      "path": "example-path",
      "content": "example-content"
    }
  ],
  "runtime": "browser-js",
  "resource": {
    "resource_id": "00000000-0000-4000-8000-000000000000",
    "operation": "example-operation",
    "environment": "test"
  },
  "timeout_seconds": 1,
  "max_output_bytes": 1
}
```

Required props: code, language, runtime, timeout_seconds, max_output_bytes.

## Example

Example document IR (the block the renderer consumes):

```json
{
  "type": "live-code",
  "props": {
    "title": "example-title",
    "code": "echo hello",
    "language": "example-language",
    "filename": "example-filename",
    "highlight_lines": [
      1
    ],
    "files": [
      {
        "path": "example-path",
        "content": "example-content"
      }
    ],
    "runtime": "browser-js",
    "resource": {
      "resource_id": "00000000-0000-4000-8000-000000000000",
      "operation": "example-operation",
      "environment": "test"
    },
    "timeout_seconds": 1,
    "max_output_bytes": 1
  }
}
```

Renderer HTML (entities decoded and wrapped for display):

```html
<section class="ds-block ds-live-code" data-component="live-code" aria-labelledby="b-title">
<h3 class="ds-block-title" id="b-title">example-title</h3>
<p class="ds-code-caption">example-filename</p>
<pre class="ds-code" data-lang="example-language">
<code>echo hello</code>
</pre>
<p class="ds-code-caption">example-path</p>
<pre class="ds-code" data-lang="text">
<code>example-content</code>
</pre>
<dl class="ds-facts">
<div>
<dt>Runtime</dt>
<dd>
<code>browser-js</code>
</dd>
</div>
<div>
<dt>Time limit</dt>
<dd>1 s</dd>
</div>
<div>
<dt>Output limit</dt>
<dd>1 byte</dd>
</div>
<div>
<dt>Runs</dt>
<dd>
<code>example-operation</code> in the test environment</dd>
</div>
</dl>
<p class="ds-live-note" role="note">Running this example needs the live documentation site; the complete source is shown above.</p>
</section>
```

Preview (interface-only; the markup above is the same output):

The renderer resolves this component as a native block; the preview above is its real HTML output, and Markdown parity for native blocks is covered by the renderer test suite.

## Specification

Generated from `packages/contracts/component-specs/live-code.md`.

### Contract

Production props are normative in `../contracts/component-props/live-code.schema.json`. The corresponding `component-fixtures` manifest is only a minimal protocol fixture; use the production props schema when building the published package. The packaged artifact ships exactly its generated `component-package.json` manifest plus `props.schema.json` (the production props schema, copied byte-for-byte) and `spec.md` (this spec, copied byte-for-byte); it contains no executable payload, fallback implementation, Storybook, test suite, SSR harness or README. Rendering behavior and the acceptance cases below belong to the renderer and the repository tests, not to the package. Installation pins the package version and the digest of every shipped byte.

### Intended behavior

Runs only in isolated executor, explicit run click/authorized tool; session teardown, output limits and version-pinned dependencies.

### Failure and fallback

Budget/permission failure leaves code readable and Copy available.

### Required acceptance cases

Infinite loop cancelled; attempted network/key read denied; deterministic result when test fixture used. Also test empty data, loading, denied access, browser without JS, mobile 360px, keyboard navigation, dark mode and an explicit constrained agent tool call. The server independently authorizes capability requests; a package manifest cannot grant authority.

### Data and maintenance

Data bindings resolve from a specific publication/release vector and permitted fact/evidence graph. Configuration edits create versioned component patches. Update invalidation uses dependency IDs, never indiscriminate whole-page regeneration. Human-owned props survive automatic updates unless invalidated with an explicit conflict. Missing optional resources leave an honest inert/readable fallback, not a broken page or fake success.

### Cost and tools

Pure/local interaction must never invoke a model by accident. Any model, remote query or executor call must reserve approved budget before dispatch. Public visitors do not inherit owner resources. The component may call only named tools in its signed manifest with valid typed inputs. A cancelled job stops polling and closes resources. No component gets platform administration, raw credentials or an unlimited execution loop.

## Package manifest

Protocol fixture: `packages/contracts/component-fixtures/live-code.json`.

| Field | Value |
| --- | --- |
| Name | @docsloth/live-code |
| Version | 1.0.0 |
| Protocol | 1.x |
| License | Apache-2.0 |
| Runtime | react |
| Entry | dist/index.js |
| Recording policy | blocked |
| Fallback | html, markdown, json |
| Network hosts | none |
| Production write | no |
| Max runtime seconds | 120 |
| Integrity | all zeros (protocol fixture placeholder) |

| Tool | Effect | Confirmation | Input |
| --- | --- | --- | --- |
| run | execute | no | value |
| cancel | read | no | value |
| reset | local_write | no | value |

## Sources

| Source | Path |
| --- | --- |
| Component page | https://registry.docsloth.dev/components/live-code.html |
| Markdown twin | https://registry.docsloth.dev/docs/live-code.md |
| LLM index | https://registry.docsloth.dev/llms.txt |
| Specification | packages/contracts/component-specs/live-code.md |
| Prop schema | packages/contracts/component-props/live-code.schema.json |
| Protocol fixture | packages/contracts/component-fixtures/live-code.json |
| Catalog | packages/contracts/component-catalog.json |


---

# terminal

Interactive command example with sandbox binding

| Field | Value |
| --- | --- |
| Trust class | connected |
| Implementation status | implemented_native |
| Renderer | native block |
| Key prop (production schema) | commands |
| Key prop (protocol fixture) | command |
| Tools | run, cancel |
| Package version | 1.0.0 |
| Package digest | sha256:914d3972d1e9577538f9f5f96871a0f428431248dff81c8a5a13e643ef02e280 |

## Install

```sh
docsloth component add @docsloth/terminal@1.0.0
```

Live package: sha256:914d3972d1e9577538f9f5f96871a0f428431248dff81c8a5a13e643ef02e280 with 2 file digest(s); the catalog entry is generated from the built package, not a placeholder.

## Props

The prop schema is normative in `packages/contracts/component-props/terminal.schema.json`.

| Prop | Type | Required | Constraints |
| --- | --- | --- | --- |
| `title` | string | no | maxLength: 160 |
| `commands` | array<string> | yes |  |
| `resource` | object | no | additionalProperties: false |
| `resource.resource_id` | string | yes | format: uuid |
| `resource.operation` | string | yes | maxLength: 160 |
| `resource.environment` | "test" \| "staging" \| "production" | yes |  |
| `cwd` | string | no |  |
| `read_only` | boolean | yes |  |
| `timeout_seconds` | integer | yes |  |

Example props generated from this schema:

```json
{
  "title": "example-title",
  "commands": [
    "example-commands"
  ],
  "resource": {
    "resource_id": "00000000-0000-4000-8000-000000000000",
    "operation": "example-operation",
    "environment": "test"
  },
  "cwd": "example-cwd",
  "read_only": true,
  "timeout_seconds": 1
}
```

Required props: commands, read_only, timeout_seconds.

## Example

Example document IR (the block the renderer consumes):

```json
{
  "type": "terminal",
  "props": {
    "title": "example-title",
    "commands": [
      "example-commands"
    ],
    "resource": {
      "resource_id": "00000000-0000-4000-8000-000000000000",
      "operation": "example-operation",
      "environment": "test"
    },
    "cwd": "example-cwd",
    "read_only": true,
    "timeout_seconds": 1
  }
}
```

Renderer HTML (entities decoded and wrapped for display):

```html
<section class="ds-block ds-terminal" data-component="terminal" aria-labelledby="b-title">
<h3 class="ds-block-title" id="b-title">example-title</h3>
<pre class="ds-code" data-lang="shell">
<code>example-commands</code>
</pre>
<dl class="ds-facts">
<div>
<dt>Working directory</dt>
<dd>
<code>example-cwd</code>
</dd>
</div>
<div>
<dt>Mode</dt>
<dd>Read-only</dd>
</div>
<div>
<dt>Time limit</dt>
<dd>1 s</dd>
</div>
<div>
<dt>Runs</dt>
<dd>
<code>example-operation</code> in the test environment</dd>
</div>
</dl>
<p class="ds-live-note" role="note">Running these commands needs the live documentation site; copy them to run them yourself.</p>
</section>
```

Preview (interface-only; the markup above is the same output):

The renderer resolves this component as a native block; the preview above is its real HTML output, and Markdown parity for native blocks is covered by the renderer test suite.

## Specification

Generated from `packages/contracts/component-specs/terminal.md`.

### Contract

Production props are normative in `../contracts/component-props/terminal.schema.json`. The corresponding `component-fixtures` manifest is only a minimal protocol fixture; use the production props schema when building the published package. The packaged artifact ships exactly its generated `component-package.json` manifest plus `props.schema.json` (the production props schema, copied byte-for-byte) and `spec.md` (this spec, copied byte-for-byte); it contains no executable payload, fallback implementation, Storybook, test suite, SSR harness or README. Rendering behavior and the acceptance cases below belong to the renderer and the repository tests, not to the package. Installation pins the package version and the digest of every shipped byte.

### Intended behavior

Display typed commands and simulated output; live mode isolated sandbox, shell strings never interpolated into host shell.

### Failure and fallback

Write denied outside sandbox; show simulation label.

### Required acceptance cases

User-entered command cannot access control-plane FS or instance metadata. Also test empty data, loading, denied access, browser without JS, mobile 360px, keyboard navigation, dark mode and an explicit constrained agent tool call. The server independently authorizes capability requests; a package manifest cannot grant authority.

### Data and maintenance

Data bindings resolve from a specific publication/release vector and permitted fact/evidence graph. Configuration edits create versioned component patches. Update invalidation uses dependency IDs, never indiscriminate whole-page regeneration. Human-owned props survive automatic updates unless invalidated with an explicit conflict. Missing optional resources leave an honest inert/readable fallback, not a broken page or fake success.

### Cost and tools

Pure/local interaction must never invoke a model by accident. Any model, remote query or executor call must reserve approved budget before dispatch. Public visitors do not inherit owner resources. The component may call only named tools in its signed manifest with valid typed inputs. A cancelled job stops polling and closes resources. No component gets platform administration, raw credentials or an unlimited execution loop.

## Package manifest

Protocol fixture: `packages/contracts/component-fixtures/terminal.json`.

| Field | Value |
| --- | --- |
| Name | @docsloth/terminal |
| Version | 1.0.0 |
| Protocol | 1.x |
| License | Apache-2.0 |
| Runtime | react |
| Entry | dist/index.js |
| Recording policy | blocked |
| Fallback | html, markdown, json |
| Network hosts | none |
| Production write | no |
| Max runtime seconds | 120 |
| Integrity | all zeros (protocol fixture placeholder) |

| Tool | Effect | Confirmation | Input |
| --- | --- | --- | --- |
| run | execute | no | value |
| cancel | read | no | value |

## Sources

| Source | Path |
| --- | --- |
| Component page | https://registry.docsloth.dev/components/terminal.html |
| Markdown twin | https://registry.docsloth.dev/docs/terminal.md |
| LLM index | https://registry.docsloth.dev/llms.txt |
| Specification | packages/contracts/component-specs/terminal.md |
| Prop schema | packages/contracts/component-props/terminal.schema.json |
| Protocol fixture | packages/contracts/component-fixtures/terminal.json |
| Catalog | packages/contracts/component-catalog.json |


---

# api-console

Build and send approved API requests

| Field | Value |
| --- | --- |
| Trust class | connected |
| Implementation status | implemented_native |
| Renderer | native block |
| Key prop (production schema) | operation_id |
| Key prop (protocol fixture) | operationId |
| Tools | configure, send, inspect |
| Package version | 1.0.0 |
| Package digest | sha256:e2d20263016327695c6b887f034a41e2d977e643fe3d7e2f68938951b102ffdc |

## Install

```sh
docsloth component add @docsloth/api-console@1.0.0
```

Live package: sha256:e2d20263016327695c6b887f034a41e2d977e643fe3d7e2f68938951b102ffdc with 2 file digest(s); the catalog entry is generated from the built package, not a placeholder.

## Props

The prop schema is normative in `packages/contracts/component-props/api-console.schema.json`.

| Prop | Type | Required | Constraints |
| --- | --- | --- | --- |
| `title` | string | no | maxLength: 160 |
| `operation_id` | string | yes |  |
| `schema_ref` | string | yes | maxLength: 256 |
| `resource` | object | no | additionalProperties: false |
| `resource.resource_id` | string | yes | format: uuid |
| `resource.operation` | string | yes | maxLength: 160 |
| `resource.environment` | "test" \| "staging" \| "production" | yes |  |
| `default_request` | object | no | additionalProperties: false |
| `default_request.parameters` | object | yes |  |
| `default_request.body` | object \| array \| string \| null | yes |  |
| `allow_live` | boolean | yes |  |

Example props generated from this schema:

```json
{
  "title": "example-title",
  "operation_id": "example-operation_id",
  "schema_ref": "example-schema_ref",
  "resource": {
    "resource_id": "00000000-0000-4000-8000-000000000000",
    "operation": "example-operation",
    "environment": "test"
  },
  "default_request": {
    "parameters": {},
    "body": null
  },
  "allow_live": true
}
```

Required props: operation_id, schema_ref, allow_live.

## Example

Example document IR (the block the renderer consumes):

```json
{
  "type": "api-console",
  "props": {
    "title": "example-title",
    "operation_id": "example-operation_id",
    "schema_ref": "example-schema_ref",
    "resource": {
      "resource_id": "00000000-0000-4000-8000-000000000000",
      "operation": "example-operation",
      "environment": "test"
    },
    "default_request": {
      "parameters": {},
      "body": null
    },
    "allow_live": true
  }
}
```

Renderer HTML (entities decoded and wrapped for display):

```html
<section class="ds-block ds-api-console" data-component="api-console" aria-labelledby="b-title">
<h3 class="ds-block-title" id="b-title">example-title</h3>
<dl class="ds-facts">
<div>
<dt>Operation</dt>
<dd>
<code>example-operation_id</code>
</dd>
</div>
<div>
<dt>Schema</dt>
<dd>
<code>example-schema_ref</code>
</dd>
</div>
<div>
<dt>Requests</dt>
<dd>Live requests allowed</dd>
</div>
<div>
<dt>Runs</dt>
<dd>
<code>example-operation</code> in the test environment</dd>
</div>
</dl>
<p class="ds-live-note" role="note">Sending requests needs the live documentation site; the operation and example request are shown above.</p>
</section>
```

Preview (interface-only; the markup above is the same output):

The renderer resolves this component as a native block; the preview above is its real HTML output, and Markdown parity for native blocks is covered by the renderer test suite.

## Specification

Generated from `packages/contracts/component-specs/api-console.md`.

### Contract

Production props are normative in `../contracts/component-props/api-console.schema.json`. The corresponding `component-fixtures` manifest is only a minimal protocol fixture; use the production props schema when building the published package. The packaged artifact ships exactly its generated `component-package.json` manifest plus `props.schema.json` (the production props schema, copied byte-for-byte) and `spec.md` (this spec, copied byte-for-byte); it contains no executable payload, fallback implementation, Storybook, test suite, SSR harness or README. Rendering behavior and the acceptance cases below belong to the renderer and the repository tests, not to the package. Installation pins the package version and the digest of every shipped byte.

### Intended behavior

Parameter form generated from contract, explicit environment badge, broker request/response redaction.

### Failure and fallback

Server rejects off-schema/host/method request even when browser altered.

### Required acceptance cases

GET/POST examples use signed test resource; production-write confirmation exact payload hash. Also test empty data, loading, denied access, browser without JS, mobile 360px, keyboard navigation, dark mode and an explicit constrained agent tool call. The server independently authorizes capability requests; a package manifest cannot grant authority.

### Data and maintenance

Data bindings resolve from a specific publication/release vector and permitted fact/evidence graph. Configuration edits create versioned component patches. Update invalidation uses dependency IDs, never indiscriminate whole-page regeneration. Human-owned props survive automatic updates unless invalidated with an explicit conflict. Missing optional resources leave an honest inert/readable fallback, not a broken page or fake success.

### Cost and tools

Pure/local interaction must never invoke a model by accident. Any model, remote query or executor call must reserve approved budget before dispatch. Public visitors do not inherit owner resources. The component may call only named tools in its signed manifest with valid typed inputs. A cancelled job stops polling and closes resources. No component gets platform administration, raw credentials or an unlimited execution loop.

## Package manifest

Protocol fixture: `packages/contracts/component-fixtures/api-console.json`.

| Field | Value |
| --- | --- |
| Name | @docsloth/api-console |
| Version | 1.0.0 |
| Protocol | 1.x |
| License | Apache-2.0 |
| Runtime | react |
| Entry | dist/index.js |
| Recording policy | blocked |
| Fallback | html, markdown, json |
| Network hosts | none |
| Production write | no |
| Max runtime seconds | 120 |
| Integrity | all zeros (protocol fixture placeholder) |

| Tool | Effect | Confirmation | Input |
| --- | --- | --- | --- |
| configure | local_write | no | value |
| send | external_write | yes | value |
| inspect | read | no | value |

## Sources

| Source | Path |
| --- | --- |
| Component page | https://registry.docsloth.dev/components/api-console.html |
| Markdown twin | https://registry.docsloth.dev/docs/api-console.md |
| LLM index | https://registry.docsloth.dev/llms.txt |
| Specification | packages/contracts/component-specs/api-console.md |
| Prop schema | packages/contracts/component-props/api-console.schema.json |
| Protocol fixture | packages/contracts/component-fixtures/api-console.json |
| Catalog | packages/contracts/component-catalog.json |


---

# api-reference

Render canonical API schema and examples

| Field | Value |
| --- | --- |
| Trust class | pure |
| Implementation status | implemented_native |
| Renderer | native block |
| Key prop (production schema) | operation_id |
| Key prop (protocol fixture) | operationId |
| Tools | none |
| Package version | 1.0.0 |
| Package digest | sha256:f160e0216f9fe7a01fe1e831d6ed8eeed9f996726ef6e6e810789b2fe591875f |

## Install

```sh
docsloth component add @docsloth/api-reference@1.0.0
```

Live package: sha256:f160e0216f9fe7a01fe1e831d6ed8eeed9f996726ef6e6e810789b2fe591875f with 2 file digest(s); the catalog entry is generated from the built package, not a placeholder.

## Props

The prop schema is normative in `packages/contracts/component-props/api-reference.schema.json`.

| Prop | Type | Required | Constraints |
| --- | --- | --- | --- |
| `title` | string | no | maxLength: 160 |
| `operation_id` | string | yes |  |
| `schema_ref` | string | yes | maxLength: 256 |
| `language_examples` | array<object> | no |  |

Example props generated from this schema:

```json
{
  "title": "example-title",
  "operation_id": "example-operation_id",
  "schema_ref": "example-schema_ref",
  "language_examples": [
    {
      "language": "example-language",
      "code": "echo hello"
    }
  ]
}
```

Required props: operation_id, schema_ref.

## Example

Example document IR (the block the renderer consumes):

```json
{
  "type": "api-reference",
  "props": {
    "title": "example-title",
    "operation_id": "example-operation_id",
    "schema_ref": "example-schema_ref",
    "language_examples": [
      {
        "language": "example-language",
        "code": "echo hello"
      }
    ]
  }
}
```

Renderer HTML (entities decoded and wrapped for display):

```html
<section class="ds-block ds-api-reference" data-component="api-reference" aria-labelledby="b-title">
<h3 class="ds-block-title" id="b-title">example-title</h3>
<dl class="ds-facts">
<div>
<dt>Operation</dt>
<dd>
<code>example-operation_id</code>
</dd>
</div>
<div>
<dt>Schema</dt>
<dd>
<code>example-schema_ref</code>
</dd>
</div>
</dl>
<div class="ds-group">
<h4 class="ds-block-subtitle">example-language</h4>
<pre class="ds-code" data-lang="example-language">
<code>echo hello</code>
</pre>
</div>
</section>
```

Preview (interface-only; the markup above is the same output):

The renderer resolves this component as a native block; the preview above is its real HTML output, and Markdown parity for native blocks is covered by the renderer test suite.

## Specification

Generated from `packages/contracts/component-specs/api-reference.md`.

### Contract

Production props are normative in `../contracts/component-props/api-reference.schema.json`. The corresponding `component-fixtures` manifest is only a minimal protocol fixture; use the production props schema when building the published package. The packaged artifact ships exactly its generated `component-package.json` manifest plus `props.schema.json` (the production props schema, copied byte-for-byte) and `spec.md` (this spec, copied byte-for-byte); it contains no executable payload, fallback implementation, Storybook, test suite, SSR harness or README. Rendering behavior and the acceptance cases below belong to the renderer and the repository tests, not to the package. Installation pins the package version and the digest of every shipped byte.

### Intended behavior

Render deterministic method, path, auth, constraints, request/response/errors from snapshot contract.

### Failure and fallback

Unsupported schema keywords marked, not dropped into wrong reference.

### Required acceptance cases

Rendered required/default/nullable match schema fixture. Also test empty data, loading, denied access, browser without JS, mobile 360px, keyboard navigation, dark mode and an explicit constrained agent tool call. The server independently authorizes capability requests; a package manifest cannot grant authority.

### Data and maintenance

Data bindings resolve from a specific publication/release vector and permitted fact/evidence graph. Configuration edits create versioned component patches. Update invalidation uses dependency IDs, never indiscriminate whole-page regeneration. Human-owned props survive automatic updates unless invalidated with an explicit conflict. Missing optional resources leave an honest inert/readable fallback, not a broken page or fake success.

### Cost and tools

Pure/local interaction must never invoke a model by accident. Any model, remote query or executor call must reserve approved budget before dispatch. Public visitors do not inherit owner resources. The component may call only named tools in its signed manifest with valid typed inputs. A cancelled job stops polling and closes resources. No component gets platform administration, raw credentials or an unlimited execution loop.

## Package manifest

Protocol fixture: `packages/contracts/component-fixtures/api-reference.json`.

| Field | Value |
| --- | --- |
| Name | @docsloth/api-reference |
| Version | 1.0.0 |
| Protocol | 1.x |
| License | Apache-2.0 |
| Runtime | react |
| Entry | dist/index.js |
| Recording policy | masked |
| Fallback | html, markdown, json |
| Network hosts | none |
| Production write | no |
| Max runtime seconds | 0 |
| Integrity | all zeros (protocol fixture placeholder) |

## Sources

| Source | Path |
| --- | --- |
| Component page | https://registry.docsloth.dev/components/api-reference.html |
| Markdown twin | https://registry.docsloth.dev/docs/api-reference.md |
| LLM index | https://registry.docsloth.dev/llms.txt |
| Specification | packages/contracts/component-specs/api-reference.md |
| Prop schema | packages/contracts/component-props/api-reference.schema.json |
| Protocol fixture | packages/contracts/component-fixtures/api-reference.json |
| Catalog | packages/contracts/component-catalog.json |


---

# schema-explorer

Explore an object or database schema

| Field | Value |
| --- | --- |
| Trust class | interactive |
| Implementation status | implemented_native |
| Renderer | native block |
| Key prop (production schema) | schema_ref |
| Key prop (protocol fixture) | schemaId |
| Tools | expand, focus |
| Package version | 1.0.0 |
| Package digest | sha256:6ef70bb86f675d5c9d7211c26af8da82a2e0b20b0ec7cc35b9ed93247f1427f5 |

## Install

```sh
docsloth component add @docsloth/schema-explorer@1.0.0
```

Live package: sha256:6ef70bb86f675d5c9d7211c26af8da82a2e0b20b0ec7cc35b9ed93247f1427f5 with 2 file digest(s); the catalog entry is generated from the built package, not a placeholder.

## Props

The prop schema is normative in `packages/contracts/component-props/schema-explorer.schema.json`.

| Prop | Type | Required | Constraints |
| --- | --- | --- | --- |
| `title` | string | no | maxLength: 160 |
| `schema_ref` | string | yes | maxLength: 256 |
| `root_pointer` | string | no |  |
| `expand_depth` | integer | no |  |

Example props generated from this schema:

```json
{
  "title": "example-title",
  "schema_ref": "example-schema_ref",
  "root_pointer": "example-root_pointer",
  "expand_depth": 1
}
```

Required props: schema_ref.

## Example

Example document IR (the block the renderer consumes):

```json
{
  "type": "schema-explorer",
  "props": {
    "title": "example-title",
    "schema_ref": "example-schema_ref",
    "root_pointer": "example-root_pointer",
    "expand_depth": 1
  }
}
```

Renderer HTML (entities decoded and wrapped for display):

```html
<section class="ds-block ds-schema-explorer" data-component="schema-explorer" aria-labelledby="b-title">
<h3 class="ds-block-title" id="b-title">example-title</h3>
<dl class="ds-facts">
<div>
<dt>Schema</dt>
<dd>
<code>example-schema_ref</code>
</dd>
</div>
<div>
<dt>Starts at</dt>
<dd>
<code>example-root_pointer</code>
</dd>
</div>
<div>
<dt>Expanded levels</dt>
<dd>1</dd>
</div>
</dl>
<p class="ds-live-note" role="note">Browsing this schema interactively needs the live documentation site.</p>
</section>
```

Preview (interface-only; the markup above is the same output):

The renderer resolves this component as a native block; the preview above is its real HTML output, and Markdown parity for native blocks is covered by the renderer test suite.

## Specification

Generated from `packages/contracts/component-specs/schema-explorer.md`.

### Contract

Production props are normative in `../contracts/component-props/schema-explorer.schema.json`. The corresponding `component-fixtures` manifest is only a minimal protocol fixture; use the production props schema when building the published package. The packaged artifact ships exactly its generated `component-package.json` manifest plus `props.schema.json` (the production props schema, copied byte-for-byte) and `spec.md` (this spec, copied byte-for-byte); it contains no executable payload, fallback implementation, Storybook, test suite, SSR harness or README. Rendering behavior and the acceptance cases below belong to the renderer and the repository tests, not to the package. Installation pins the package version and the digest of every shipped byte.

### Intended behavior

Search fields and expand recursion with cycle guards, explicit nullable/union/allOf.

### Failure and fallback

Unresolved external $ref shown as unresolved; no network fetch without resource authority.

### Required acceptance cases

Recursive type terminates; API and database presentation use explicit schema kind. Also test empty data, loading, denied access, browser without JS, mobile 360px, keyboard navigation, dark mode and an explicit constrained agent tool call. The server independently authorizes capability requests; a package manifest cannot grant authority.

### Data and maintenance

Data bindings resolve from a specific publication/release vector and permitted fact/evidence graph. Configuration edits create versioned component patches. Update invalidation uses dependency IDs, never indiscriminate whole-page regeneration. Human-owned props survive automatic updates unless invalidated with an explicit conflict. Missing optional resources leave an honest inert/readable fallback, not a broken page or fake success.

### Cost and tools

Pure/local interaction must never invoke a model by accident. Any model, remote query or executor call must reserve approved budget before dispatch. Public visitors do not inherit owner resources. The component may call only named tools in its signed manifest with valid typed inputs. A cancelled job stops polling and closes resources. No component gets platform administration, raw credentials or an unlimited execution loop.

## Package manifest

Protocol fixture: `packages/contracts/component-fixtures/schema-explorer.json`.

| Field | Value |
| --- | --- |
| Name | @docsloth/schema-explorer |
| Version | 1.0.0 |
| Protocol | 1.x |
| License | Apache-2.0 |
| Runtime | react |
| Entry | dist/index.js |
| Recording policy | masked |
| Fallback | html, markdown, json |
| Network hosts | none |
| Production write | no |
| Max runtime seconds | 0 |
| Integrity | all zeros (protocol fixture placeholder) |

| Tool | Effect | Confirmation | Input |
| --- | --- | --- | --- |
| expand | read | no | value |
| focus | read | no | value |

## Sources

| Source | Path |
| --- | --- |
| Component page | https://registry.docsloth.dev/components/schema-explorer.html |
| Markdown twin | https://registry.docsloth.dev/docs/schema-explorer.md |
| LLM index | https://registry.docsloth.dev/llms.txt |
| Specification | packages/contracts/component-specs/schema-explorer.md |
| Prop schema | packages/contracts/component-props/schema-explorer.schema.json |
| Protocol fixture | packages/contracts/component-fixtures/schema-explorer.json |
| Catalog | packages/contracts/component-catalog.json |


---

# graph

Explore services and software relationships

| Field | Value |
| --- | --- |
| Trust class | interactive |
| Implementation status | implemented_native |
| Renderer | native block |
| Key prop (production schema) | graph_query |
| Key prop (protocol fixture) | graphId |
| Tools | focus, highlight_path, filter |
| Package version | 1.0.0 |
| Package digest | sha256:6d641e2333187733121c947497d74eee9cc38bf0a6ea4f2504fa0b83ae1fa14e |

## Install

```sh
docsloth component add @docsloth/graph@1.0.0
```

Live package: sha256:6d641e2333187733121c947497d74eee9cc38bf0a6ea4f2504fa0b83ae1fa14e with 2 file digest(s); the catalog entry is generated from the built package, not a placeholder.

## Props

The prop schema is normative in `packages/contracts/component-props/graph.schema.json`.

| Prop | Type | Required | Constraints |
| --- | --- | --- | --- |
| `title` | string | no | maxLength: 160 |
| `graph_query` | object | yes | additionalProperties: false |
| `graph_query.snapshot_id` | string | yes | format: uuid |
| `graph_query.root_ids` | array<string> | yes |  |
| `graph_query.edge_kinds` | array<string> | yes |  |
| `graph_query.max_nodes` | integer | yes |  |
| `layout` | "dag" \| "force" \| "radial" | yes |  |
| `show_uncertain_edges` | boolean | no |  |

Example props generated from this schema:

```json
{
  "title": "example-title",
  "graph_query": {
    "snapshot_id": "00000000-0000-4000-8000-000000000000",
    "root_ids": [
      "00000000-0000-4000-8000-000000000000"
    ],
    "edge_kinds": [
      "example-edge_kinds"
    ],
    "max_nodes": 1
  },
  "layout": "dag",
  "show_uncertain_edges": true
}
```

Required props: graph_query, layout.

## Example

Example document IR (the block the renderer consumes):

```json
{
  "type": "graph",
  "props": {
    "title": "example-title",
    "graph_query": {
      "snapshot_id": "00000000-0000-4000-8000-000000000000",
      "root_ids": [
        "00000000-0000-4000-8000-000000000000"
      ],
      "edge_kinds": [
        "example-edge_kinds"
      ],
      "max_nodes": 1
    },
    "layout": "dag",
    "show_uncertain_edges": true
  }
}
```

Renderer HTML (entities decoded and wrapped for display):

```html
<section class="ds-block ds-graph" data-component="graph" aria-labelledby="b-title">
<h3 class="ds-block-title" id="b-title">example-title</h3>
<dl class="ds-facts">
<div>
<dt>Layout</dt>
<dd>dag</dd>
</div>
<div>
<dt>Edge kinds</dt>
<dd>
<code>example-edge_kinds</code>
</dd>
</div>
<div>
<dt>Starting nodes</dt>
<dd>1</dd>
</div>
<div>
<dt>Node limit</dt>
<dd>1</dd>
</div>
<div>
<dt>Uncertain edges</dt>
<dd>Shown</dd>
</div>
</dl>
<p class="ds-live-note" role="note">The interactive graph is drawn on the live documentation site.</p>
</section>
```

Preview (interface-only; the markup above is the same output):

The renderer resolves this component as a native block; the preview above is its real HTML output, and Markdown parity for native blocks is covered by the renderer test suite.

## Specification

Generated from `packages/contracts/component-specs/graph.md`.

### Contract

Production props are normative in `../contracts/component-props/graph.schema.json`. The corresponding `component-fixtures` manifest is only a minimal protocol fixture; use the production props schema when building the published package. The packaged artifact ships exactly its generated `component-package.json` manifest plus `props.schema.json` (the production props schema, copied byte-for-byte) and `spec.md` (this spec, copied byte-for-byte); it contains no executable payload, fallback implementation, Storybook, test suite, SSR harness or README. Rendering behavior and the acceptance cases below belong to the renderer and the repository tests, not to the package. Installation pins the package version and the digest of every shipped byte.

### Intended behavior

Interactive graph plus equivalent accessible adjacency table; source-confidence styling and keyboard focus.

### Failure and fallback

Missing permission removes node and associated edges before rendering.

### Required acceptance cases

Click/filter/highlight never returns inaccessible nodes; deterministic snapshot IDs. Also test empty data, loading, denied access, browser without JS, mobile 360px, keyboard navigation, dark mode and an explicit constrained agent tool call. The server independently authorizes capability requests; a package manifest cannot grant authority.

### Data and maintenance

Data bindings resolve from a specific publication/release vector and permitted fact/evidence graph. Configuration edits create versioned component patches. Update invalidation uses dependency IDs, never indiscriminate whole-page regeneration. Human-owned props survive automatic updates unless invalidated with an explicit conflict. Missing optional resources leave an honest inert/readable fallback, not a broken page or fake success.

### Cost and tools

Pure/local interaction must never invoke a model by accident. Any model, remote query or executor call must reserve approved budget before dispatch. Public visitors do not inherit owner resources. The component may call only named tools in its signed manifest with valid typed inputs. A cancelled job stops polling and closes resources. No component gets platform administration, raw credentials or an unlimited execution loop.

## Package manifest

Protocol fixture: `packages/contracts/component-fixtures/graph.json`.

| Field | Value |
| --- | --- |
| Name | @docsloth/graph |
| Version | 1.0.0 |
| Protocol | 1.x |
| License | Apache-2.0 |
| Runtime | react |
| Entry | dist/index.js |
| Recording policy | masked |
| Fallback | html, markdown, json |
| Network hosts | none |
| Production write | no |
| Max runtime seconds | 0 |
| Integrity | all zeros (protocol fixture placeholder) |

| Tool | Effect | Confirmation | Input |
| --- | --- | --- | --- |
| focus | read | no | value |
| highlight_path | read | no | value |
| filter | read | no | value |

## Sources

| Source | Path |
| --- | --- |
| Component page | https://registry.docsloth.dev/components/graph.html |
| Markdown twin | https://registry.docsloth.dev/docs/graph.md |
| LLM index | https://registry.docsloth.dev/llms.txt |
| Specification | packages/contracts/component-specs/graph.md |
| Prop schema | packages/contracts/component-props/graph.schema.json |
| Protocol fixture | packages/contracts/component-fixtures/graph.json |
| Catalog | packages/contracts/component-catalog.json |


---

# sequence

Explain message ordering

| Field | Value |
| --- | --- |
| Trust class | interactive |
| Implementation status | implemented_native |
| Renderer | native block |
| Key prop (production schema) | participants |
| Key prop (protocol fixture) | diagram |
| Tools | step, reset |
| Package version | 1.0.0 |
| Package digest | sha256:a080361d569b2b4b1c48a7c4f749c8028ae367d6d2122fb97ae86dd146f809ea |

## Install

```sh
docsloth component add @docsloth/sequence@1.0.0
```

Live package: sha256:a080361d569b2b4b1c48a7c4f749c8028ae367d6d2122fb97ae86dd146f809ea with 2 file digest(s); the catalog entry is generated from the built package, not a placeholder.

## Props

The prop schema is normative in `packages/contracts/component-props/sequence.schema.json`.

| Prop | Type | Required | Constraints |
| --- | --- | --- | --- |
| `title` | string | no | maxLength: 160 |
| `participants` | array<object> | yes |  |
| `messages` | array<object> | yes |  |
| `autoplay` | boolean | no |  |

Example props generated from this schema:

```json
{
  "title": "example-title",
  "participants": [
    {
      "id": "example-id",
      "label": "example-label"
    }
  ],
  "messages": [
    {
      "from": "example-from",
      "to": "example-to",
      "label": "example-label",
      "fact_ids": [
        "00000000-0000-4000-8000-000000000000"
      ]
    }
  ],
  "autoplay": true
}
```

Required props: participants, messages.

## Example

Example document IR (the block the renderer consumes):

```json
{
  "type": "sequence",
  "props": {
    "title": "example-title",
    "participants": [
      {
        "id": "example-id",
        "label": "example-label"
      }
    ],
    "messages": [
      {
        "from": "example-from",
        "to": "example-to",
        "label": "example-label",
        "fact_ids": [
          "00000000-0000-4000-8000-000000000000"
        ]
      }
    ],
    "autoplay": true
  }
}
```

Renderer HTML (entities decoded and wrapped for display):

```html
<section class="ds-block ds-sequence" data-component="sequence" aria-labelledby="b-title">
<h3 class="ds-block-title" id="b-title">example-title</h3>
<dl class="ds-facts">
<div>
<dt>Participants</dt>
<dd>example-label</dd>
</div>
</dl>
<ol class="ds-list">
<li>
<strong>example-from</strong> → <strong>example-to</strong>: example-label</li>
</ol>
</section>
```

Preview (interface-only; the markup above is the same output):

The renderer resolves this component as a native block; the preview above is its real HTML output, and Markdown parity for native blocks is covered by the renderer test suite.

## Specification

Generated from `packages/contracts/component-specs/sequence.md`.

### Contract

Production props are normative in `../contracts/component-props/sequence.schema.json`. The corresponding `component-fixtures` manifest is only a minimal protocol fixture; use the production props schema when building the published package. The packaged artifact ships exactly its generated `component-package.json` manifest plus `props.schema.json` (the production props schema, copied byte-for-byte) and `spec.md` (this spec, copied byte-for-byte); it contains no executable payload, fallback implementation, Storybook, test suite, SSR harness or README. Rendering behavior and the acceptance cases below belong to the renderer and the repository tests, not to the package. Installation pins the package version and the digest of every shipped byte.

### Intended behavior

Step-through messages with text-order equivalent; no autoplay by default.

### Failure and fallback

Missing participant is validation failure, not invented node.

### Required acceptance cases

Messages preserve causality order; reduced-motion no animations. Also test empty data, loading, denied access, browser without JS, mobile 360px, keyboard navigation, dark mode and an explicit constrained agent tool call. The server independently authorizes capability requests; a package manifest cannot grant authority.

### Data and maintenance

Data bindings resolve from a specific publication/release vector and permitted fact/evidence graph. Configuration edits create versioned component patches. Update invalidation uses dependency IDs, never indiscriminate whole-page regeneration. Human-owned props survive automatic updates unless invalidated with an explicit conflict. Missing optional resources leave an honest inert/readable fallback, not a broken page or fake success.

### Cost and tools

Pure/local interaction must never invoke a model by accident. Any model, remote query or executor call must reserve approved budget before dispatch. Public visitors do not inherit owner resources. The component may call only named tools in its signed manifest with valid typed inputs. A cancelled job stops polling and closes resources. No component gets platform administration, raw credentials or an unlimited execution loop.

## Package manifest

Protocol fixture: `packages/contracts/component-fixtures/sequence.json`.

| Field | Value |
| --- | --- |
| Name | @docsloth/sequence |
| Version | 1.0.0 |
| Protocol | 1.x |
| License | Apache-2.0 |
| Runtime | react |
| Entry | dist/index.js |
| Recording policy | masked |
| Fallback | html, markdown, json |
| Network hosts | none |
| Production write | no |
| Max runtime seconds | 0 |
| Integrity | all zeros (protocol fixture placeholder) |

| Tool | Effect | Confirmation | Input |
| --- | --- | --- | --- |
| step | read | no | value |
| reset | local_write | no | value |

## Sources

| Source | Path |
| --- | --- |
| Component page | https://registry.docsloth.dev/components/sequence.html |
| Markdown twin | https://registry.docsloth.dev/docs/sequence.md |
| LLM index | https://registry.docsloth.dev/llms.txt |
| Specification | packages/contracts/component-specs/sequence.md |
| Prop schema | packages/contracts/component-props/sequence.schema.json |
| Protocol fixture | packages/contracts/component-fixtures/sequence.json |
| Catalog | packages/contracts/component-catalog.json |


---

# state-machine

Explore a bounded state machine

| Field | Value |
| --- | --- |
| Trust class | interactive |
| Implementation status | implemented_native |
| Renderer | native block |
| Key prop (production schema) | workflow_id |
| Key prop (protocol fixture) | workflowId |
| Tools | transition, reset |
| Package version | 1.0.0 |
| Package digest | sha256:91bd9464a06f102f68ad96545904912e91352b4972210f60025c8635e3f1b613 |

## Install

```sh
docsloth component add @docsloth/state-machine@1.0.0
```

Live package: sha256:91bd9464a06f102f68ad96545904912e91352b4972210f60025c8635e3f1b613 with 2 file digest(s); the catalog entry is generated from the built package, not a placeholder.

## Props

The prop schema is normative in `packages/contracts/component-props/state-machine.schema.json`.

| Prop | Type | Required | Constraints |
| --- | --- | --- | --- |
| `title` | string | no | maxLength: 160 |
| `workflow_id` | string | yes | maxLength: 256 |
| `initial_state` | string | yes | maxLength: 256 |
| `states` | array<string> | yes |  |
| `transitions` | array<object> | yes |  |

Example props generated from this schema:

```json
{
  "title": "example-title",
  "workflow_id": "example-workflow_id",
  "initial_state": "example-initial_state",
  "states": [
    "example-states"
  ],
  "transitions": [
    {
      "from": "example-from",
      "to": "example-to",
      "event": "example-event",
      "guard_description": "example-guard_description"
    }
  ]
}
```

Required props: workflow_id, initial_state, states, transitions.

## Example

Example document IR (the block the renderer consumes):

```json
{
  "type": "state-machine",
  "props": {
    "title": "example-title",
    "workflow_id": "example-workflow_id",
    "initial_state": "example-initial_state",
    "states": [
      "example-states"
    ],
    "transitions": [
      {
        "from": "example-from",
        "to": "example-to",
        "event": "example-event",
        "guard_description": "example-guard_description"
      }
    ]
  }
}
```

Renderer HTML (entities decoded and wrapped for display):

```html
<section class="ds-block ds-state-machine" data-component="state-machine" aria-labelledby="b-title">
<h3 class="ds-block-title" id="b-title">example-title</h3>
<dl class="ds-facts">
<div>
<dt>Workflow</dt>
<dd>
<code>example-workflow_id</code>
</dd>
</div>
<div>
<dt>Initial state</dt>
<dd>
<code>example-initial_state</code>
</dd>
</div>
<div>
<dt>States</dt>
<dd>
<code>example-states</code>
</dd>
</div>
</dl>
<table class="ds-table">
<caption>Transitions</caption>
<thead>
<tr>
<th scope="col">From</th>
<th scope="col">Event</th>
<th scope="col">To</th>
<th scope="col">Guard</th>
</tr>
</thead>
<tbody>
<tr>
<td>example-from</td>
<td>example-event</td>
<td>example-to</td>
<td>example-guard_description</td>
</tr>
</tbody>
</table>
</section>
```

Preview (interface-only; the markup above is the same output):

The renderer resolves this component as a native block; the preview above is its real HTML output, and Markdown parity for native blocks is covered by the renderer test suite.

## Specification

Generated from `packages/contracts/component-specs/state-machine.md`.

### Contract

Production props are normative in `../contracts/component-props/state-machine.schema.json`. The corresponding `component-fixtures` manifest is only a minimal protocol fixture; use the production props schema when building the published package. The packaged artifact ships exactly its generated `component-package.json` manifest plus `props.schema.json` (the production props schema, copied byte-for-byte) and `spec.md` (this spec, copied byte-for-byte); it contains no executable payload, fallback implementation, Storybook, test suite, SSR harness or README. Rendering behavior and the acceptance cases below belong to the renderer and the repository tests, not to the package. Installation pins the package version and the digest of every shipped byte.

### Intended behavior

Simulate documented local states, label simulation versus live system status.

### Failure and fallback

Guard not satisfied explains blocker and no state mutation.

### Required acceptance cases

No illegal transition accepted by UI or AI tool. Also test empty data, loading, denied access, browser without JS, mobile 360px, keyboard navigation, dark mode and an explicit constrained agent tool call. The server independently authorizes capability requests; a package manifest cannot grant authority.

### Data and maintenance

Data bindings resolve from a specific publication/release vector and permitted fact/evidence graph. Configuration edits create versioned component patches. Update invalidation uses dependency IDs, never indiscriminate whole-page regeneration. Human-owned props survive automatic updates unless invalidated with an explicit conflict. Missing optional resources leave an honest inert/readable fallback, not a broken page or fake success.

### Cost and tools

Pure/local interaction must never invoke a model by accident. Any model, remote query or executor call must reserve approved budget before dispatch. Public visitors do not inherit owner resources. The component may call only named tools in its signed manifest with valid typed inputs. A cancelled job stops polling and closes resources. No component gets platform administration, raw credentials or an unlimited execution loop.

## Package manifest

Protocol fixture: `packages/contracts/component-fixtures/state-machine.json`.

| Field | Value |
| --- | --- |
| Name | @docsloth/state-machine |
| Version | 1.0.0 |
| Protocol | 1.x |
| License | Apache-2.0 |
| Runtime | react |
| Entry | dist/index.js |
| Recording policy | masked |
| Fallback | html, markdown, json |
| Network hosts | none |
| Production write | no |
| Max runtime seconds | 0 |
| Integrity | all zeros (protocol fixture placeholder) |

| Tool | Effect | Confirmation | Input |
| --- | --- | --- | --- |
| transition | read | no | value |
| reset | local_write | no | value |

## Sources

| Source | Path |
| --- | --- |
| Component page | https://registry.docsloth.dev/components/state-machine.html |
| Markdown twin | https://registry.docsloth.dev/docs/state-machine.md |
| LLM index | https://registry.docsloth.dev/llms.txt |
| Specification | packages/contracts/component-specs/state-machine.md |
| Prop schema | packages/contracts/component-props/state-machine.schema.json |
| Protocol fixture | packages/contracts/component-fixtures/state-machine.json |
| Catalog | packages/contracts/component-catalog.json |


---

# tutorial

Verified multistep task tutorial

| Field | Value |
| --- | --- |
| Trust class | connected |
| Implementation status | implemented_native |
| Renderer | native block |
| Key prop (production schema) | workflow_id |
| Key prop (protocol fixture) | workflowId |
| Tools | next, verify, reset |
| Package version | 1.0.0 |
| Package digest | sha256:d8935cd3b71884c7b5704305752a4a464fcd43a97e37e08aaeefbed5bc7897d2 |

## Install

```sh
docsloth component add @docsloth/tutorial@1.0.0
```

Live package: sha256:d8935cd3b71884c7b5704305752a4a464fcd43a97e37e08aaeefbed5bc7897d2 with 2 file digest(s); the catalog entry is generated from the built package, not a placeholder.

## Props

The prop schema is normative in `packages/contracts/component-props/tutorial.schema.json`.

| Prop | Type | Required | Constraints |
| --- | --- | --- | --- |
| `title` | string | no | maxLength: 160 |
| `workflow_id` | string | yes | maxLength: 256 |
| `steps` | array<object> | yes |  |
| `resource` | object | no | additionalProperties: false |
| `resource.resource_id` | string | yes | format: uuid |
| `resource.operation` | string | yes | maxLength: 160 |
| `resource.environment` | "test" \| "staging" \| "production" | yes |  |
| `persist_progress` | boolean | yes |  |

Example props generated from this schema:

```json
{
  "title": "example-title",
  "workflow_id": "example-workflow_id",
  "steps": [
    {
      "id": "example-id",
      "title": "example-title",
      "block_ids": [
        "00000000-0000-4000-8000-000000000000"
      ],
      "check_id": "example-check_id",
      "required": true
    }
  ],
  "resource": {
    "resource_id": "00000000-0000-4000-8000-000000000000",
    "operation": "example-operation",
    "environment": "test"
  },
  "persist_progress": true
}
```

Required props: workflow_id, steps, persist_progress.

## Example

Example document IR (the block the renderer consumes):

```json
{
  "type": "tutorial",
  "props": {
    "title": "example-title",
    "workflow_id": "example-workflow_id",
    "steps": [
      {
        "id": "example-id",
        "title": "example-title",
        "block_ids": [
          "00000000-0000-4000-8000-000000000000"
        ],
        "check_id": "example-check_id",
        "required": true
      }
    ],
    "resource": {
      "resource_id": "00000000-0000-4000-8000-000000000000",
      "operation": "example-operation",
      "environment": "test"
    },
    "persist_progress": true
  }
}
```

Renderer HTML (entities decoded and wrapped for display):

```html
<section class="ds-block ds-tutorial" data-component="tutorial" aria-labelledby="b-title">
<h3 class="ds-block-title" id="b-title">example-title</h3>
<ol class="ds-list">
<li>
<strong>example-title</strong> (required) — verified by <code>example-check_id</code>
</li>
</ol>
<dl class="ds-facts">
<div>
<dt>Workflow</dt>
<dd>
<code>example-workflow_id</code>
</dd>
</div>
<div>
<dt>Progress</dt>
<dd>Saved between visits</dd>
</div>
<div>
<dt>Runs</dt>
<dd>
<code>example-operation</code> in the test environment</dd>
</div>
</dl>
<p class="ds-live-note" role="note">Step checks and saved progress need the live documentation site.</p>
</section>
```

Preview (interface-only; the markup above is the same output):

The renderer resolves this component as a native block; the preview above is its real HTML output, and Markdown parity for native blocks is covered by the renderer test suite.

## Specification

Generated from `packages/contracts/component-specs/tutorial.md`.

### Contract

Production props are normative in `../contracts/component-props/tutorial.schema.json`. The corresponding `component-fixtures` manifest is only a minimal protocol fixture; use the production props schema when building the published package. The packaged artifact ships exactly its generated `component-package.json` manifest plus `props.schema.json` (the production props schema, copied byte-for-byte) and `spec.md` (this spec, copied byte-for-byte); it contains no executable payload, fallback implementation, Storybook, test suite, SSR harness or README. Rendering behavior and the acceptance cases below belong to the renderer and the repository tests, not to the package. Installation pins the package version and the digest of every shipped byte.

### Intended behavior

Durable scoped progress tied to publication/version; completion depends on actual configured checks.

### Failure and fallback

Blocked step permits viewing next content but not false completion.

### Required acceptance cases

Failed check remains failed after refresh; reset scoped session only. Also test empty data, loading, denied access, browser without JS, mobile 360px, keyboard navigation, dark mode and an explicit constrained agent tool call. The server independently authorizes capability requests; a package manifest cannot grant authority.

### Data and maintenance

Data bindings resolve from a specific publication/release vector and permitted fact/evidence graph. Configuration edits create versioned component patches. Update invalidation uses dependency IDs, never indiscriminate whole-page regeneration. Human-owned props survive automatic updates unless invalidated with an explicit conflict. Missing optional resources leave an honest inert/readable fallback, not a broken page or fake success.

### Cost and tools

Pure/local interaction must never invoke a model by accident. Any model, remote query or executor call must reserve approved budget before dispatch. Public visitors do not inherit owner resources. The component may call only named tools in its signed manifest with valid typed inputs. A cancelled job stops polling and closes resources. No component gets platform administration, raw credentials or an unlimited execution loop.

### React tutorial adapter

Production `workflow_id`, `steps`, `persist_progress` and optional `resource` select a host binding from `ComponentContentProvider.tutorials`, keyed with `tutorialKey(workflow_id, resource)` from `@docsloth/official-components/host`. Step `block_ids` resolve only through this provider's already authorized blocks. All instructions and native step links work without JavaScript. Browsing later steps after failure is allowed and never changes check results. There are at most 100 steps, 50 block references per step and 1,000 references overall; duplicate step IDs and invalid inputs refuse. Missing content is labelled rather than fabricated.

An available adapter names the exact release ID, workflow ID/version, actor session ID, persistence mode (`durable` or `session`), and a progress snapshot. Snapshots include the same scope, a revision and a map keyed by step ID. Each result names the configured `check_id` and has `not_run`, `passed`, `failed` or `blocked` status, plus an optional public-safe message. Only matching configured passed checks count toward required completion. Missing, restricted, loading, wrong-scope or malformed progress never becomes success. Persisted failures are rendered on reload; `persist_progress: true` requires the host's durable mode, rather than silently using local storage.

Optional `verify` and `reset` callbacks receive the exact scope, expected progress revision, persistence choice and abort signal; verify additionally receives the selected step/check IDs. They return typed `ok` progress, `permission_required`, `unsupported` or `failed`. HTTP success or stdout is not a check result. Reset affects the bound tutorial session only and must return cleared checks. Failed or invalid replies retain previous results. Replacing workflow/release/session or host progress invalidates outstanding results; stopping aborts the adapter and discards late responses. The UI does not claim an already-started remote mutation was rolled back.

The host must independently authorize capability and audience, validate published steps/checks, reserve approved execution budget, compare revisions and persist results/reset atomically. Its `durable` declaration is a contract, not evidence that browser storage is durable. This component does not dispatch arbitrary `/v1/executions` requests, store proofs in localStorage, create grants, or manufacture passed outcomes. Actual core/cloud transport, durable storage and constrained agent-tool wiring remain host integration work; the browser acceptance fixture exercises the adapter over HTTP with scoped server state across reloads, not a production database deployment.

## Package manifest

Protocol fixture: `packages/contracts/component-fixtures/tutorial.json`.

| Field | Value |
| --- | --- |
| Name | @docsloth/tutorial |
| Version | 1.0.0 |
| Protocol | 1.x |
| License | Apache-2.0 |
| Runtime | react |
| Entry | dist/index.js |
| Recording policy | blocked |
| Fallback | html, markdown, json |
| Network hosts | none |
| Production write | no |
| Max runtime seconds | 120 |
| Integrity | all zeros (protocol fixture placeholder) |

| Tool | Effect | Confirmation | Input |
| --- | --- | --- | --- |
| next | read | no | value |
| verify | execute | no | value |
| reset | local_write | no | value |

## Sources

| Source | Path |
| --- | --- |
| Component page | https://registry.docsloth.dev/components/tutorial.html |
| Markdown twin | https://registry.docsloth.dev/docs/tutorial.md |
| LLM index | https://registry.docsloth.dev/llms.txt |
| Specification | packages/contracts/component-specs/tutorial.md |
| Prop schema | packages/contracts/component-props/tutorial.schema.json |
| Protocol fixture | packages/contracts/component-fixtures/tutorial.json |
| Catalog | packages/contracts/component-catalog.json |


---

# wizard

Collect configuration and validate prerequisites

| Field | Value |
| --- | --- |
| Trust class | connected |
| Implementation status | implemented_native |
| Renderer | native block |
| Key prop (production schema) | workflow_id |
| Key prop (protocol fixture) | workflowId |
| Tools | next, validate |
| Package version | 1.0.0 |
| Package digest | sha256:500b2eb0f2f3cd3c5ec3a66e20981fec775e727c18547a8105edddb8d5c55862 |

## Install

```sh
docsloth component add @docsloth/wizard@1.0.0
```

Live package: sha256:500b2eb0f2f3cd3c5ec3a66e20981fec775e727c18547a8105edddb8d5c55862 with 2 file digest(s); the catalog entry is generated from the built package, not a placeholder.

## Props

The prop schema is normative in `packages/contracts/component-props/wizard.schema.json`.

| Prop | Type | Required | Constraints |
| --- | --- | --- | --- |
| `title` | string | no | maxLength: 160 |
| `workflow_id` | string | yes | maxLength: 256 |
| `input_schema` | object | yes |  |
| `steps` | array<object> | yes |  |
| `resource` | object | no | additionalProperties: false |
| `resource.resource_id` | string | yes | format: uuid |
| `resource.operation` | string | yes | maxLength: 160 |
| `resource.environment` | "test" \| "staging" \| "production" | yes |  |

Example props generated from this schema:

```json
{
  "title": "example-title",
  "workflow_id": "example-workflow_id",
  "input_schema": {},
  "steps": [
    {
      "id": "example-id",
      "fields": [
        "example-fields"
      ]
    }
  ],
  "resource": {
    "resource_id": "00000000-0000-4000-8000-000000000000",
    "operation": "example-operation",
    "environment": "test"
  }
}
```

Required props: workflow_id, input_schema, steps.

## Example

Example document IR (the block the renderer consumes):

```json
{
  "type": "wizard",
  "props": {
    "title": "example-title",
    "workflow_id": "example-workflow_id",
    "input_schema": {},
    "steps": [
      {
        "id": "example-id",
        "fields": [
          "example-fields"
        ]
      }
    ],
    "resource": {
      "resource_id": "00000000-0000-4000-8000-000000000000",
      "operation": "example-operation",
      "environment": "test"
    }
  }
}
```

Renderer HTML (entities decoded and wrapped for display):

```html
<section class="ds-block ds-wizard" data-component="wizard" aria-labelledby="b-title">
<h3 class="ds-block-title" id="b-title">example-title</h3>
<ol class="ds-list">
<li>
<code>example-id</code>: <code>example-fields</code>
</li>
</ol>
<dl class="ds-facts">
<div>
<dt>Workflow</dt>
<dd>
<code>example-workflow_id</code>
</dd>
</div>
<div>
<dt>Runs</dt>
<dd>
<code>example-operation</code> in the test environment</dd>
</div>
</dl>
<p class="ds-live-note" role="note">Filling in and validating this wizard needs the live documentation site.</p>
</section>
```

Preview (interface-only; the markup above is the same output):

The renderer resolves this component as a native block; the preview above is its real HTML output, and Markdown parity for native blocks is covered by the renderer test suite.

## Specification

Generated from `packages/contracts/component-specs/wizard.md`.

### Contract

Production props are normative in `../contracts/component-props/wizard.schema.json`. The corresponding `component-fixtures` manifest is only a minimal protocol fixture; use the production props schema when building the published package. The packaged artifact ships exactly its generated `component-package.json` manifest plus `props.schema.json` (the production props schema, copied byte-for-byte) and `spec.md` (this spec, copied byte-for-byte); it contains no executable payload, fallback implementation, Storybook, test suite, SSR harness or README. Rendering behavior and the acceptance cases below belong to the renderer and the repository tests, not to the package. Installation pins the package version and the digest of every shipped byte.

### Intended behavior

JSON-schema guided config with accessible errors; secrets use broker set-secret flow, never ordinary fields.

### Failure and fallback

Invalid value cannot advance required step.

### Required acceptance cases

Back navigation retains nonsecret values; no hidden paid-resource enable. Also test empty data, loading, denied access, browser without JS, mobile 360px, keyboard navigation, dark mode and an explicit constrained agent tool call. The server independently authorizes capability requests; a package manifest cannot grant authority.

### Data and maintenance

Data bindings resolve from a specific publication/release vector and permitted fact/evidence graph. Configuration edits create versioned component patches. Update invalidation uses dependency IDs, never indiscriminate whole-page regeneration. Human-owned props survive automatic updates unless invalidated with an explicit conflict. Missing optional resources leave an honest inert/readable fallback, not a broken page or fake success.

### Cost and tools

Pure/local interaction must never invoke a model by accident. Any model, remote query or executor call must reserve approved budget before dispatch. Public visitors do not inherit owner resources. The component may call only named tools in its signed manifest with valid typed inputs. A cancelled job stops polling and closes resources. No component gets platform administration, raw credentials or an unlimited execution loop.

### React configuration adapter

Production `workflow_id`, `input_schema`, `steps` and optional `resource` define a local draft. The current renderer supports a bounded flat JSON Schema 2020-12 object: string, number, safe integer and boolean properties; required fields; scalar enum/const choices; Unicode code-point length and numeric bounds; and nonsecret defaults. Unsupported types, references, conditional or regular-expression constraints refuse the entire form instead of silently weakening validation. Every property must appear in exactly one step; no invisible defaults can enable resources. There are at most 100 fields and 100 steps, 100 choices per field, 4,096 UTF-16 code units per ordinary input and 65,536 overall. Optional untouched fields remain absent; zero, false and an explicitly entered empty string keep their meaning. Back retains nonsecret draft values.

Fields marked `writeOnly: true`, `format: "password"`, or common credential names use only a separate host secret broker. Secret defaults are ignored and secret enum/const values refuse. The wizard never renders a raw secret input. Schema authors must mark other credential fields explicitly; name matching is not a complete secret classifier. The host must not deliver actual secrets as props, annotations or defaults: omitting them from the UI cannot protect bytes already sent to a browser. The broker owns entry, validates secret constraints and returns an opaque reference; references are kept separately from nonsecret values and are never displayed.

`ComponentContentProvider.wizards` selects a binding with `wizardKey(workflow_id, resource)` from `@docsloth/official-components/host`. Available bindings name the release ID, workflow ID/version and actor session ID. Optional `setSecret` receives that scope, the field ID and an abort signal. Its typed `stored` result must repeat the scope, field ID and bounded opaque reference. Optional `validate` receives the scope, typed `values`, separate `secretReferences` and an abort signal. It returns scoped `validated` with a public-safe summary, scoped `invalid` with known field errors, or `permission_required`, `unsupported` or `failed`. HTTP success alone never proves validation. Messages must not contain secrets.

Next and Back are local. The last step opens a review; a separate explicit action invokes configured prerequisite validation. This wizard never applies configuration, enables a paid resource, issues arbitrary execution requests or persists drafts in browser storage. Without JavaScript all fields remain readable with actions disabled. Missing/restricted/loading adapters are labelled; required secrets cannot advance without the broker. Scope changes clear drafts and references. Stop waiting aborts the adapter and discards late replies without claiming remote rollback. The host must independently authorize the exact published workflow/resource, reserve approved budget, validate all submitted values and reference ownership/liveness, and enforce the schema again on the server. Real broker, core/cloud transport and constrained agent-tool dispatch remain host integration work; browser tests exercise this adapter over a scoped HTTP fixture.

## Package manifest

Protocol fixture: `packages/contracts/component-fixtures/wizard.json`.

| Field | Value |
| --- | --- |
| Name | @docsloth/wizard |
| Version | 1.0.0 |
| Protocol | 1.x |
| License | Apache-2.0 |
| Runtime | react |
| Entry | dist/index.js |
| Recording policy | blocked |
| Fallback | html, markdown, json |
| Network hosts | none |
| Production write | no |
| Max runtime seconds | 120 |
| Integrity | all zeros (protocol fixture placeholder) |

| Tool | Effect | Confirmation | Input |
| --- | --- | --- | --- |
| next | read | no | value |
| validate | execute | no | value |

## Sources

| Source | Path |
| --- | --- |
| Component page | https://registry.docsloth.dev/components/wizard.html |
| Markdown twin | https://registry.docsloth.dev/docs/wizard.md |
| LLM index | https://registry.docsloth.dev/llms.txt |
| Specification | packages/contracts/component-specs/wizard.md |
| Prop schema | packages/contracts/component-props/wizard.schema.json |
| Protocol fixture | packages/contracts/component-fixtures/wizard.json |
| Catalog | packages/contracts/component-catalog.json |


---

# chat

Page-scoped sourced documentation assistance

| Field | Value |
| --- | --- |
| Trust class | agentic |
| Implementation status | implemented_native |
| Renderer | native block |
| Key prop (production schema) | scope |
| Key prop (protocol fixture) | prompt |
| Tools | ask, cancel |
| Package version | 1.0.0 |
| Package digest | sha256:55a9c459b0ce2a7b41171891978283f50ebab10688169dc2620db9e6fd5ba92a |

## Install

```sh
docsloth component add @docsloth/chat@1.0.0
```

Live package: sha256:55a9c459b0ce2a7b41171891978283f50ebab10688169dc2620db9e6fd5ba92a with 2 file digest(s); the catalog entry is generated from the built package, not a placeholder.

## Props

The prop schema is normative in `packages/contracts/component-props/chat.schema.json`.

| Prop | Type | Required | Constraints |
| --- | --- | --- | --- |
| `title` | string | no | maxLength: 160 |
| `scope` | object | yes | additionalProperties: false |
| `scope.publication_id` | string | yes | format: uuid |
| `scope.page_ids` | array<string> | yes |  |
| `model_resource_id` | string | no | format: uuid |
| `tools` | array<string> | yes |  |
| `welcome` | string | yes |  |
| `max_turns` | integer | yes |  |
| `show_sources` | boolean | yes |  |

Example props generated from this schema:

```json
{
  "title": "example-title",
  "scope": {
    "publication_id": "00000000-0000-4000-8000-000000000000",
    "page_ids": [
      "00000000-0000-4000-8000-000000000000"
    ]
  },
  "model_resource_id": "00000000-0000-4000-8000-000000000000",
  "tools": [
    "example-tools"
  ],
  "welcome": "example-welcome",
  "max_turns": 1,
  "show_sources": true
}
```

Required props: scope, tools, welcome, max_turns, show_sources.

## Example

Example document IR (the block the renderer consumes):

```json
{
  "type": "chat",
  "props": {
    "title": "example-title",
    "scope": {
      "publication_id": "00000000-0000-4000-8000-000000000000",
      "page_ids": [
        "00000000-0000-4000-8000-000000000000"
      ]
    },
    "model_resource_id": "00000000-0000-4000-8000-000000000000",
    "tools": [
      "example-tools"
    ],
    "welcome": "example-welcome",
    "max_turns": 1,
    "show_sources": true
  }
}
```

Renderer HTML (entities decoded and wrapped for display):

```html
<section class="ds-block ds-chat" data-component="chat" aria-labelledby="b-title">
<h3 class="ds-block-title" id="b-title">example-title</h3>
<blockquote>
<p>example-welcome</p>
</blockquote>
<dl class="ds-facts">
<div>
<dt>Answers</dt>
<dd>Cite their sources</dd>
</div>
<div>
<dt>Tools</dt>
<dd>
<code>example-tools</code>
</dd>
</div>
<div>
<dt>Turn limit</dt>
<dd>1</dd>
</div>
</dl>
<p class="ds-live-note" role="note">Asking questions needs the live documentation site.</p>
</section>
```

Preview (interface-only; the markup above is the same output):

The renderer resolves this component as a native block; the preview above is its real HTML output, and Markdown parity for native blocks is covered by the renderer test suite.

## Specification

Generated from `packages/contracts/component-specs/chat.md`.

### Contract

Production props are normative in `../contracts/component-props/chat.schema.json`. The corresponding `component-fixtures` manifest is only a minimal protocol fixture; use the production props schema when building the published package. The packaged artifact ships exactly its generated `component-package.json` manifest plus `props.schema.json` (the production props schema, copied byte-for-byte) and `spec.md` (this spec, copied byte-for-byte); it contains no executable payload, fallback implementation, Storybook, test suite, SSR harness or README. Rendering behavior and the acceptance cases below belong to the renderer and the repository tests, not to the package. Installation pins the package version and the digest of every shipped byte.

### Intended behavior

Read-only sourced answers by default; actions in separate confirmation cards; token/cost authority server-side.

### Failure and fallback

Provider down or budget exhausted displays source search fallback, not fabricated answer.

### Required acceptance cases

No page prompt injection changes tools or private visibility. Also test empty data, loading, denied access, browser without JS, mobile 360px, keyboard navigation, dark mode and an explicit constrained agent tool call. The server independently authorizes capability requests; a package manifest cannot grant authority.

### Data and maintenance

Data bindings resolve from a specific publication/release vector and permitted fact/evidence graph. Configuration edits create versioned component patches. Update invalidation uses dependency IDs, never indiscriminate whole-page regeneration. Human-owned props survive automatic updates unless invalidated with an explicit conflict. Missing optional resources leave an honest inert/readable fallback, not a broken page or fake success.

### Cost and tools

Pure/local interaction must never invoke a model by accident. Any model, remote query or executor call must reserve approved budget before dispatch. Public visitors do not inherit owner resources. The component may call only named tools in its signed manifest with valid typed inputs. A cancelled job stops polling and closes resources. No component gets platform administration, raw credentials or an unlimited execution loop.

## Package manifest

Protocol fixture: `packages/contracts/component-fixtures/chat.json`.

| Field | Value |
| --- | --- |
| Name | @docsloth/chat |
| Version | 1.0.0 |
| Protocol | 1.x |
| License | Apache-2.0 |
| Runtime | react |
| Entry | dist/index.js |
| Recording policy | blocked |
| Fallback | html, markdown, json |
| Network hosts | none |
| Production write | no |
| Max runtime seconds | 120 |
| Integrity | all zeros (protocol fixture placeholder) |

| Tool | Effect | Confirmation | Input |
| --- | --- | --- | --- |
| ask | execute | no | value |
| cancel | read | no | value |

## Sources

| Source | Path |
| --- | --- |
| Component page | https://registry.docsloth.dev/components/chat.html |
| Markdown twin | https://registry.docsloth.dev/docs/chat.md |
| LLM index | https://registry.docsloth.dev/llms.txt |
| Specification | packages/contracts/component-specs/chat.md |
| Prop schema | packages/contracts/component-props/chat.schema.json |
| Protocol fixture | packages/contracts/component-fixtures/chat.json |
| Catalog | packages/contracts/component-catalog.json |


---

# chat-bubble

Floating contextual documentation assistant

| Field | Value |
| --- | --- |
| Trust class | agentic |
| Implementation status | implemented_native |
| Renderer | native block |
| Key prop (production schema) | scope |
| Key prop (protocol fixture) | prompt |
| Tools | open, ask, close |
| Package version | 1.0.0 |
| Package digest | sha256:f2e372a38f97e05c8c303a956f54e973ef86e492737e677fe41e792a8e5fde60 |

## Install

```sh
docsloth component add @docsloth/chat-bubble@1.0.0
```

Live package: sha256:f2e372a38f97e05c8c303a956f54e973ef86e492737e677fe41e792a8e5fde60 with 2 file digest(s); the catalog entry is generated from the built package, not a placeholder.

## Props

The prop schema is normative in `packages/contracts/component-props/chat-bubble.schema.json`.

| Prop | Type | Required | Constraints |
| --- | --- | --- | --- |
| `title` | string | no | maxLength: 160 |
| `scope` | object | yes | additionalProperties: false |
| `scope.publication_id` | string | yes | format: uuid |
| `scope.page_ids` | array<string> | yes |  |
| `model_resource_id` | string | no | format: uuid |
| `position` | "bottom-right" \| "bottom-left" | yes |  |
| `label` | string | yes | maxLength: 80 |
| `tools` | array<string> | yes |  |

Example props generated from this schema:

```json
{
  "title": "example-title",
  "scope": {
    "publication_id": "00000000-0000-4000-8000-000000000000",
    "page_ids": [
      "00000000-0000-4000-8000-000000000000"
    ]
  },
  "model_resource_id": "00000000-0000-4000-8000-000000000000",
  "position": "bottom-right",
  "label": "example-label",
  "tools": [
    "example-tools"
  ]
}
```

Required props: scope, position, label, tools.

## Example

Example document IR (the block the renderer consumes):

```json
{
  "type": "chat-bubble",
  "props": {
    "title": "example-title",
    "scope": {
      "publication_id": "00000000-0000-4000-8000-000000000000",
      "page_ids": [
        "00000000-0000-4000-8000-000000000000"
      ]
    },
    "model_resource_id": "00000000-0000-4000-8000-000000000000",
    "position": "bottom-right",
    "label": "example-label",
    "tools": [
      "example-tools"
    ]
  }
}
```

Renderer HTML (entities decoded and wrapped for display):

```html
<section class="ds-block ds-chat-bubble" data-component="chat-bubble" aria-labelledby="b-title">
<h3 class="ds-block-title" id="b-title">example-title</h3>
<p>example-label</p>
<dl class="ds-facts">
<div>
<dt>Tools</dt>
<dd>
<code>example-tools</code>
</dd>
</div>
</dl>
<p class="ds-live-note" role="note">The chat assistant opens on the live documentation site.</p>
</section>
```

Preview (interface-only; the markup above is the same output):

The renderer resolves this component as a native block; the preview above is its real HTML output, and Markdown parity for native blocks is covered by the renderer test suite.

## Specification

Generated from `packages/contracts/component-specs/chat-bubble.md`.

### Contract

Production props are normative in `../contracts/component-props/chat-bubble.schema.json`. The corresponding `component-fixtures` manifest is only a minimal protocol fixture; use the production props schema when building the published package. The packaged artifact ships exactly its generated `component-package.json` manifest plus `props.schema.json` (the production props schema, copied byte-for-byte) and `spec.md` (this spec, copied byte-for-byte); it contains no executable payload, fallback implementation, Storybook, test suite, SSR harness or README. Rendering behavior and the acceptance cases below belong to the renderer and the repository tests, not to the package. Installation pins the package version and the digest of every shipped byte.

### Intended behavior

Accessible dialog reusing chat controller; never auto-open on focus or conceal main action.

### Failure and fallback

No model set produces configure/admin message only to owner; reader sees search.

### Required acceptance cases

Mobile keyboard/dialog focus return and ESC close tested. Also test empty data, loading, denied access, browser without JS, mobile 360px, keyboard navigation, dark mode and an explicit constrained agent tool call. The server independently authorizes capability requests; a package manifest cannot grant authority.

### Data and maintenance

Data bindings resolve from a specific publication/release vector and permitted fact/evidence graph. Configuration edits create versioned component patches. Update invalidation uses dependency IDs, never indiscriminate whole-page regeneration. Human-owned props survive automatic updates unless invalidated with an explicit conflict. Missing optional resources leave an honest inert/readable fallback, not a broken page or fake success.

### Cost and tools

Pure/local interaction must never invoke a model by accident. Any model, remote query or executor call must reserve approved budget before dispatch. Public visitors do not inherit owner resources. The component may call only named tools in its signed manifest with valid typed inputs. A cancelled job stops polling and closes resources. No component gets platform administration, raw credentials or an unlimited execution loop.

## Package manifest

Protocol fixture: `packages/contracts/component-fixtures/chat-bubble.json`.

| Field | Value |
| --- | --- |
| Name | @docsloth/chat-bubble |
| Version | 1.0.0 |
| Protocol | 1.x |
| License | Apache-2.0 |
| Runtime | react |
| Entry | dist/index.js |
| Recording policy | blocked |
| Fallback | html, markdown, json |
| Network hosts | none |
| Production write | no |
| Max runtime seconds | 120 |
| Integrity | all zeros (protocol fixture placeholder) |

| Tool | Effect | Confirmation | Input |
| --- | --- | --- | --- |
| open | read | no | value |
| ask | execute | no | value |
| close | read | no | value |

## Sources

| Source | Path |
| --- | --- |
| Component page | https://registry.docsloth.dev/components/chat-bubble.html |
| Markdown twin | https://registry.docsloth.dev/docs/chat-bubble.md |
| LLM index | https://registry.docsloth.dev/llms.txt |
| Specification | packages/contracts/component-specs/chat-bubble.md |
| Prop schema | packages/contracts/component-props/chat-bubble.schema.json |
| Protocol fixture | packages/contracts/component-fixtures/chat-bubble.json |
| Catalog | packages/contracts/component-catalog.json |


---

# troubleshooter

Diagnose an authorized redacted error

| Field | Value |
| --- | --- |
| Trust class | agentic |
| Implementation status | implemented_native |
| Renderer | native block |
| Key prop (production schema) | error_catalog_ref |
| Key prop (protocol fixture) | error |
| Tools | diagnose, explain |
| Package version | 1.0.0 |
| Package digest | sha256:cc7e3d2eb1477955fbf83cf9c13259694d866a527aff89adc764974179b19498 |

## Install

```sh
docsloth component add @docsloth/troubleshooter@1.0.0
```

Live package: sha256:cc7e3d2eb1477955fbf83cf9c13259694d866a527aff89adc764974179b19498 with 2 file digest(s); the catalog entry is generated from the built package, not a placeholder.

## Props

The prop schema is normative in `packages/contracts/component-props/troubleshooter.schema.json`.

| Prop | Type | Required | Constraints |
| --- | --- | --- | --- |
| `title` | string | no | maxLength: 160 |
| `error_catalog_ref` | string | yes | maxLength: 256 |
| `scope` | object | yes | additionalProperties: false |
| `scope.publication_id` | string | yes | format: uuid |
| `scope.fact_ids` | array<string> | yes |  |
| `scope.evidence_ids` | array<string> | yes |  |
| `resource` | object | no | additionalProperties: false |
| `resource.resource_id` | string | yes | format: uuid |
| `resource.operation` | string | yes | maxLength: 160 |
| `resource.environment` | "test" \| "staging" \| "production" | yes |  |
| `allow_log_upload` | boolean | yes |  |

Example props generated from this schema:

```json
{
  "title": "example-title",
  "error_catalog_ref": "example-error_catalog_ref",
  "scope": {
    "publication_id": "00000000-0000-4000-8000-000000000000",
    "fact_ids": [
      "00000000-0000-4000-8000-000000000000"
    ],
    "evidence_ids": [
      "00000000-0000-4000-8000-000000000000"
    ]
  },
  "resource": {
    "resource_id": "00000000-0000-4000-8000-000000000000",
    "operation": "example-operation",
    "environment": "test"
  },
  "allow_log_upload": true
}
```

Required props: error_catalog_ref, scope, allow_log_upload.

## Example

Example document IR (the block the renderer consumes):

```json
{
  "type": "troubleshooter",
  "props": {
    "title": "example-title",
    "error_catalog_ref": "example-error_catalog_ref",
    "scope": {
      "publication_id": "00000000-0000-4000-8000-000000000000",
      "fact_ids": [
        "00000000-0000-4000-8000-000000000000"
      ],
      "evidence_ids": [
        "00000000-0000-4000-8000-000000000000"
      ]
    },
    "resource": {
      "resource_id": "00000000-0000-4000-8000-000000000000",
      "operation": "example-operation",
      "environment": "test"
    },
    "allow_log_upload": true
  }
}
```

Renderer HTML (entities decoded and wrapped for display):

```html
<section class="ds-block ds-troubleshooter" data-component="troubleshooter" aria-labelledby="b-title">
<h3 class="ds-block-title" id="b-title">example-title</h3>
<dl class="ds-facts">
<div>
<dt>Error catalog</dt>
<dd>
<code>example-error_catalog_ref</code>
</dd>
</div>
<div>
<dt>Log upload</dt>
<dd>Allowed</dd>
</div>
<div>
<dt>Runs</dt>
<dd>
<code>example-operation</code> in the test environment</dd>
</div>
</dl>
<p class="ds-live-note" role="note">Diagnosing an error needs the live documentation site.</p>
</section>
```

Preview (interface-only; the markup above is the same output):

The renderer resolves this component as a native block; the preview above is its real HTML output, and Markdown parity for native blocks is covered by the renderer test suite.

## Specification

Generated from `packages/contracts/component-specs/troubleshooter.md`.

### Contract

Production props are normative in `../contracts/component-props/troubleshooter.schema.json`. The corresponding `component-fixtures` manifest is only a minimal protocol fixture; use the production props schema when building the published package. The packaged artifact ships exactly its generated `component-package.json` manifest plus `props.schema.json` (the production props schema, copied byte-for-byte) and `spec.md` (this spec, copied byte-for-byte); it contains no executable payload, fallback implementation, Storybook, test suite, SSR harness or README. Rendering behavior and the acceptance cases below belong to the renderer and the repository tests, not to the package. Installation pins the package version and the digest of every shipped byte.

### Intended behavior

Redact error/log text before submission, match versioned error catalog, show diagnosis uncertainty.

### Failure and fallback

Unknown error offered as hypothesis, not confirmed root cause.

### Required acceptance cases

PII fixture is masked; proposed dangerous remediation cannot execute automatically. Also test empty data, loading, denied access, browser without JS, mobile 360px, keyboard navigation, dark mode and an explicit constrained agent tool call. The server independently authorizes capability requests; a package manifest cannot grant authority.

### Data and maintenance

Data bindings resolve from a specific publication/release vector and permitted fact/evidence graph. Configuration edits create versioned component patches. Update invalidation uses dependency IDs, never indiscriminate whole-page regeneration. Human-owned props survive automatic updates unless invalidated with an explicit conflict. Missing optional resources leave an honest inert/readable fallback, not a broken page or fake success.

### Cost and tools

Pure/local interaction must never invoke a model by accident. Any model, remote query or executor call must reserve approved budget before dispatch. Public visitors do not inherit owner resources. The component may call only named tools in its signed manifest with valid typed inputs. A cancelled job stops polling and closes resources. No component gets platform administration, raw credentials or an unlimited execution loop.

### React implementation

The release-scoped `ComponentContentProvider.errorCatalogs` map binds `error_catalog_ref` to an already authorized catalog with an exact `publication_id`, immutable `version`, and plain-text entries. Each entry has `id`, `title`, literal `match` terms, `hypothesis`, manual `checks`, `fact_ids` and `evidence_ids`. The renderer includes only entries within the production scope; this filtering does not replace host audience authorization. Restricted/loading/missing bindings have explicit states. Catalog browsing and manual checks are readable without JavaScript.

Hydration enables local text entry, optional local file reading when `allow_log_upload` is true, and an explicit redacted-text review before literal catalog matching. Common email, numeric identifier, IP, credential-header/assignment, key and user-path patterns are masked. Arbitrary personal names and unusual secrets are not guaranteed to be detected. No text is submitted by this component, stored in browser persistence, copied automatically, or sent to an executor/model. File reading is local, not a connected upload service. Host telemetry must separately respect sensitive input. Results remain hypotheses; checks are escaped prose and never commands to run.

Inputs are limited to 32,768 characters and files to 65,536 bytes. Catalogs allow 200 entries, eight 128-character literal terms per entry, ten 1,000-character checks, and 500,000 combined characters including provenance IDs. At most five matching hypotheses are shown. Release, catalog-version or allowed-entry changes reset local text, and late file reads cannot restore cleared/replaced text. Resource and agent execution integration remains a host responsibility.

## Package manifest

Protocol fixture: `packages/contracts/component-fixtures/troubleshooter.json`.

| Field | Value |
| --- | --- |
| Name | @docsloth/troubleshooter |
| Version | 1.0.0 |
| Protocol | 1.x |
| License | Apache-2.0 |
| Runtime | react |
| Entry | dist/index.js |
| Recording policy | blocked |
| Fallback | html, markdown, json |
| Network hosts | none |
| Production write | no |
| Max runtime seconds | 120 |
| Integrity | all zeros (protocol fixture placeholder) |

| Tool | Effect | Confirmation | Input |
| --- | --- | --- | --- |
| diagnose | execute | no | value |
| explain | read | no | value |

## Sources

| Source | Path |
| --- | --- |
| Component page | https://registry.docsloth.dev/components/troubleshooter.html |
| Markdown twin | https://registry.docsloth.dev/docs/troubleshooter.md |
| LLM index | https://registry.docsloth.dev/llms.txt |
| Specification | packages/contracts/component-specs/troubleshooter.md |
| Prop schema | packages/contracts/component-props/troubleshooter.schema.json |
| Protocol fixture | packages/contracts/component-fixtures/troubleshooter.json |
| Catalog | packages/contracts/component-catalog.json |


---

# agent-task

Run a scoped documentation task

| Field | Value |
| --- | --- |
| Trust class | agentic |
| Implementation status | implemented_native |
| Renderer | native block |
| Key prop (production schema) | task_template |
| Key prop (protocol fixture) | task |
| Tools | plan, execute, cancel |
| Package version | 1.0.0 |
| Package digest | sha256:493a794a66adc03149587a1fbe484c41ba29d773a28afb8b1dc424117553ebc6 |

## Install

```sh
docsloth component add @docsloth/agent-task@1.0.0
```

Live package: sha256:493a794a66adc03149587a1fbe484c41ba29d773a28afb8b1dc424117553ebc6 with 2 file digest(s); the catalog entry is generated from the built package, not a placeholder.

## Props

The prop schema is normative in `packages/contracts/component-props/agent-task.schema.json`.

| Prop | Type | Required | Constraints |
| --- | --- | --- | --- |
| `title` | string | no | maxLength: 160 |
| `task_template` | string | yes | maxLength: 20000 |
| `allowed_tools` | array<string> | yes |  |
| `resource` | object | no | additionalProperties: false |
| `resource.resource_id` | string | yes | format: uuid |
| `resource.operation` | string | yes | maxLength: 160 |
| `resource.environment` | "test" \| "staging" \| "production" | yes |  |
| `max_steps` | integer | yes |  |
| `max_charge_micro_usd` | integer | yes |  |

Example props generated from this schema:

```json
{
  "title": "example-title",
  "task_template": "example-task_template",
  "allowed_tools": [
    "example-allowed_tools"
  ],
  "resource": {
    "resource_id": "00000000-0000-4000-8000-000000000000",
    "operation": "example-operation",
    "environment": "test"
  },
  "max_steps": 1,
  "max_charge_micro_usd": 1
}
```

Required props: task_template, allowed_tools, max_steps, max_charge_micro_usd.

## Example

Example document IR (the block the renderer consumes):

```json
{
  "type": "agent-task",
  "props": {
    "title": "example-title",
    "task_template": "example-task_template",
    "allowed_tools": [
      "example-allowed_tools"
    ],
    "resource": {
      "resource_id": "00000000-0000-4000-8000-000000000000",
      "operation": "example-operation",
      "environment": "test"
    },
    "max_steps": 1,
    "max_charge_micro_usd": 1
  }
}
```

Renderer HTML (entities decoded and wrapped for display):

```html
<section class="ds-block ds-agent-task" data-component="agent-task" aria-labelledby="b-title">
<h3 class="ds-block-title" id="b-title">example-title</h3>
<p class="ds-code-caption">Task</p>
<pre class="ds-code" data-lang="text">
<code>example-task_template</code>
</pre>
<dl class="ds-facts">
<div>
<dt>Tools</dt>
<dd>
<code>example-allowed_tools</code>
</dd>
</div>
<div>
<dt>Step limit</dt>
<dd>1</dd>
</div>
<div>
<dt>Budget limit</dt>
<dd>0.000001 USD</dd>
</div>
<div>
<dt>Runs</dt>
<dd>
<code>example-operation</code> in the test environment</dd>
</div>
</dl>
<p class="ds-live-note" role="note">Running this task needs the live documentation site and an approved budget.</p>
</section>
```

Preview (interface-only; the markup above is the same output):

The renderer resolves this component as a native block; the preview above is its real HTML output, and Markdown parity for native blocks is covered by the renderer test suite.

## Specification

Generated from `packages/contracts/component-specs/agent-task.md`.

### Contract

Production props are normative in `../contracts/component-props/agent-task.schema.json`. The corresponding `component-fixtures` manifest is only a minimal protocol fixture; use the production props schema when building the published package. The packaged artifact ships exactly its generated `component-package.json` manifest plus `props.schema.json` (the production props schema, copied byte-for-byte) and `spec.md` (this spec, copied byte-for-byte); it contains no executable payload, fallback implementation, Storybook, test suite, SSR harness or README. Rendering behavior and the acceptance cases below belong to the renderer and the repository tests, not to the package. Installation pins the package version and the digest of every shipped byte.

### Intended behavior

Plans bounded task then executes approved capabilities; live phase/status and cancellation.

### Failure and fallback

Tool/step ceiling stops cleanly and preserves trace.

### Required acceptance cases

No recursive agent spawn, entitlement change or secret retrieval outside task capability. Also test empty data, loading, denied access, browser without JS, mobile 360px, keyboard navigation, dark mode and an explicit constrained agent tool call. The server independently authorizes capability requests; a package manifest cannot grant authority.

### Data and maintenance

Data bindings resolve from a specific publication/release vector and permitted fact/evidence graph. Configuration edits create versioned component patches. Update invalidation uses dependency IDs, never indiscriminate whole-page regeneration. Human-owned props survive automatic updates unless invalidated with an explicit conflict. Missing optional resources leave an honest inert/readable fallback, not a broken page or fake success.

### Cost and tools

Pure/local interaction must never invoke a model by accident. Any model, remote query or executor call must reserve approved budget before dispatch. Public visitors do not inherit owner resources. The component may call only named tools in its signed manifest with valid typed inputs. A cancelled job stops polling and closes resources. No component gets platform administration, raw credentials or an unlimited execution loop.

## Package manifest

Protocol fixture: `packages/contracts/component-fixtures/agent-task.json`.

| Field | Value |
| --- | --- |
| Name | @docsloth/agent-task |
| Version | 1.0.0 |
| Protocol | 1.x |
| License | Apache-2.0 |
| Runtime | react |
| Entry | dist/index.js |
| Recording policy | blocked |
| Fallback | html, markdown, json |
| Network hosts | none |
| Production write | no |
| Max runtime seconds | 120 |
| Integrity | all zeros (protocol fixture placeholder) |

| Tool | Effect | Confirmation | Input |
| --- | --- | --- | --- |
| plan | read | no | value |
| execute | execute | no | value |
| cancel | read | no | value |

## Sources

| Source | Path |
| --- | --- |
| Component page | https://registry.docsloth.dev/components/agent-task.html |
| Markdown twin | https://registry.docsloth.dev/docs/agent-task.md |
| LLM index | https://registry.docsloth.dev/llms.txt |
| Specification | packages/contracts/component-specs/agent-task.md |
| Prop schema | packages/contracts/component-props/agent-task.schema.json |
| Protocol fixture | packages/contracts/component-fixtures/agent-task.json |
| Catalog | packages/contracts/component-catalog.json |


---

# search

Published content search with static fallback

| Field | Value |
| --- | --- |
| Trust class | interactive |
| Implementation status | implemented_native |
| Renderer | native block |
| Key prop (production schema) | index_ref |
| Key prop (protocol fixture) | query |
| Tools | search, select |
| Package version | 1.0.0 |
| Package digest | sha256:17cff85734c8002817e16d0b9d54ada0d5242f55eea5cb1d3cfa06c2ff91ae4a |

## Install

```sh
docsloth component add @docsloth/search@1.0.0
```

Live package: sha256:17cff85734c8002817e16d0b9d54ada0d5242f55eea5cb1d3cfa06c2ff91ae4a with 2 file digest(s); the catalog entry is generated from the built package, not a placeholder.

## Props

The prop schema is normative in `packages/contracts/component-props/search.schema.json`.

| Prop | Type | Required | Constraints |
| --- | --- | --- | --- |
| `title` | string | no | maxLength: 160 |
| `index_ref` | string | yes | maxLength: 256 |
| `mode` | "static" \| "managed" \| "external" | yes |  |
| `placeholder` | string | yes |  |
| `max_results` | integer | yes |  |
| `resource` | object | no | additionalProperties: false |
| `resource.resource_id` | string | yes | format: uuid |
| `resource.operation` | string | yes | maxLength: 160 |
| `resource.environment` | "test" \| "staging" \| "production" | yes |  |

Example props generated from this schema:

```json
{
  "title": "example-title",
  "index_ref": "example-index_ref",
  "mode": "static",
  "placeholder": "example-placeholder",
  "max_results": 1,
  "resource": {
    "resource_id": "00000000-0000-4000-8000-000000000000",
    "operation": "example-operation",
    "environment": "test"
  }
}
```

Required props: index_ref, mode, placeholder, max_results.

## Example

Example document IR (the block the renderer consumes):

```json
{
  "type": "search",
  "props": {
    "title": "example-title",
    "index_ref": "example-index_ref",
    "mode": "static",
    "placeholder": "example-placeholder",
    "max_results": 1,
    "resource": {
      "resource_id": "00000000-0000-4000-8000-000000000000",
      "operation": "example-operation",
      "environment": "test"
    }
  }
}
```

Renderer HTML (entities decoded and wrapped for display):

```html
<section class="ds-block ds-search" data-component="search" aria-labelledby="b-title">
<h3 class="ds-block-title" id="b-title">example-title</h3>
<p>example-placeholder</p>
<dl class="ds-facts">
<div>
<dt>Index</dt>
<dd>
<code>example-index_ref</code>
</dd>
</div>
<div>
<dt>Mode</dt>
<dd>static</dd>
</div>
<div>
<dt>Results per search</dt>
<dd>1</dd>
</div>
<div>
<dt>Runs</dt>
<dd>
<code>example-operation</code> in the test environment</dd>
</div>
</dl>
<p class="ds-live-note" role="note">Interactive search requires an authorized index supplied by the publication host. No search index is attached to this static view.</p>
</section>
```

Preview (interface-only; the markup above is the same output):

The renderer resolves this component as a native block; the preview above is its real HTML output, and Markdown parity for native blocks is covered by the renderer test suite.

## Specification

Generated from `packages/contracts/component-specs/search.md`.

### Contract

Production props are normative in `../contracts/component-props/search.schema.json`. The corresponding `component-fixtures` manifest is only a minimal protocol fixture; use the production props schema when building the published package. The packaged artifact ships exactly its generated `component-package.json` manifest plus `props.schema.json` (the production props schema, copied byte-for-byte) and `spec.md` (this spec, copied byte-for-byte); it contains no executable payload, fallback implementation, Storybook, test suite, SSR harness or README. Rendering behavior and the acceptance cases below belong to the renderer and the repository tests, not to the package. Installation pins the package version and the digest of every shipped byte.

### Intended behavior

Version/audience filtered search with keyboard shortcuts and no-result feedback.

### Failure and fallback

Managed unavailable falls back to public static index only, never mixed private cache.

### Required acceptance cases

Empty/long/Unicode queries safe and match highlighted text. Also test empty data, loading, denied access, browser without JS, mobile 360px, keyboard navigation, dark mode and an explicit constrained agent tool call. The server independently authorizes capability requests; a package manifest cannot grant authority.

### Data and maintenance

Data bindings resolve from a specific publication/release vector and permitted fact/evidence graph. Configuration edits create versioned component patches. Update invalidation uses dependency IDs, never indiscriminate whole-page regeneration. Human-owned props survive automatic updates unless invalidated with an explicit conflict. Missing optional resources leave an honest inert/readable fallback, not a broken page or fake success.

### Cost and tools

Pure/local interaction must never invoke a model by accident. Any model, remote query or executor call must reserve approved budget before dispatch. Public visitors do not inherit owner resources. The component may call only named tools in its signed manifest with valid typed inputs. A cancelled job stops polling and closes resources. No component gets platform administration, raw credentials or an unlimited execution loop.

### Current React host binding

`ComponentContentProvider.searchIndexes` is a readonly map keyed by production `index_ref`. Each available record declares `visibility: public | authorized` and readonly documents with `id`, `title`, optional `text`, and optional `href`. The host supplies only bytes and destinations already authorized for this audience and release, and replaces immutable snapshots when they change. These display types do not implement access control. Restricted records contain only `access: restricted`; no private index metadata is rendered.

Static mode performs literal, case-insensitive Unicode text search locally after form submission. Every whitespace-separated term must match; title matches rank first, ties retain index order, and `max_results` bounds displayed matches. Results use escaped text/highlights and validated navigation links. Queries are bounded to 256 UTF-16 units and 20 distinct terms. Indexes accept up to 1,000 unique documents, 500 units per title, 20,000 per body, 4,096 per URL and 2,000,000 total title/body units; invalid or oversized indexes show unavailable instead of silently truncating.

Initial results and a native disclosure containing every document title/link render without JavaScript. Filtering enables after hydration; Enter submits, Escape clears, and `/` from a focused result focuses the query input. Changing release or index resets the query. No browser storage, remote fetch, resource execution, embedding or model call occurs. Managed/external modes are explicitly unconnected and fall back only to a host record marked public; an authorized-only index cannot become their fallback. Live services, host-side ACLs and budgeted tool dispatch remain separate integrations.

## Package manifest

Protocol fixture: `packages/contracts/component-fixtures/search.json`.

| Field | Value |
| --- | --- |
| Name | @docsloth/search |
| Version | 1.0.0 |
| Protocol | 1.x |
| License | Apache-2.0 |
| Runtime | react |
| Entry | dist/index.js |
| Recording policy | masked |
| Fallback | html, markdown, json |
| Network hosts | none |
| Production write | no |
| Max runtime seconds | 0 |
| Integrity | all zeros (protocol fixture placeholder) |

| Tool | Effect | Confirmation | Input |
| --- | --- | --- | --- |
| search | read | no | value |
| select | local_write | no | value |

## Sources

| Source | Path |
| --- | --- |
| Component page | https://registry.docsloth.dev/components/search.html |
| Markdown twin | https://registry.docsloth.dev/docs/search.md |
| LLM index | https://registry.docsloth.dev/llms.txt |
| Specification | packages/contracts/component-specs/search.md |
| Prop schema | packages/contracts/component-props/search.schema.json |
| Protocol fixture | packages/contracts/component-fixtures/search.json |
| Catalog | packages/contracts/component-catalog.json |


---

# video

Accessible recorded walkthrough

| Field | Value |
| --- | --- |
| Trust class | interactive |
| Implementation status | implemented_native |
| Renderer | native block |
| Key prop (production schema) | asset_id |
| Key prop (protocol fixture) | src |
| Tools | play, pause, seek |
| Package version | 1.0.0 |
| Package digest | sha256:5e1d7e446c9173e2c3e46e52a9b51ce3d671998ae9bd9ae17fa8be953d8ed6e2 |

## Install

```sh
docsloth component add @docsloth/video@1.0.0
```

Live package: sha256:5e1d7e446c9173e2c3e46e52a9b51ce3d671998ae9bd9ae17fa8be953d8ed6e2 with 2 file digest(s); the catalog entry is generated from the built package, not a placeholder.

## Props

The prop schema is normative in `packages/contracts/component-props/video.schema.json`.

| Prop | Type | Required | Constraints |
| --- | --- | --- | --- |
| `title` | string | no | maxLength: 160 |
| `asset_id` | string | yes | format: uuid |
| `poster_asset_id` | string | no | format: uuid |
| `transcript_asset_id` | string | no | format: uuid |
| `captions_asset_id` | string | no | format: uuid |
| `autoplay` | boolean | yes |  |

Example props generated from this schema:

```json
{
  "title": "example-title",
  "asset_id": "00000000-0000-4000-8000-000000000000",
  "poster_asset_id": "00000000-0000-4000-8000-000000000000",
  "transcript_asset_id": "00000000-0000-4000-8000-000000000000",
  "captions_asset_id": "00000000-0000-4000-8000-000000000000",
  "autoplay": true
}
```

Required props: asset_id, autoplay.

## Example

Example document IR (the block the renderer consumes):

```json
{
  "type": "video",
  "props": {
    "title": "example-title",
    "asset_id": "00000000-0000-4000-8000-000000000000",
    "poster_asset_id": "00000000-0000-4000-8000-000000000000",
    "transcript_asset_id": "00000000-0000-4000-8000-000000000000",
    "captions_asset_id": "00000000-0000-4000-8000-000000000000",
    "autoplay": true
  }
}
```

Renderer HTML (entities decoded and wrapped for display):

```html
<section class="ds-block ds-video" data-component="video" aria-labelledby="b-title">
<h3 class="ds-block-title" id="b-title">example-title</h3>
<p class="ds-live-note" role="note">The video is served by the live documentation site.</p>
</section>
```

Preview (interface-only; the markup above is the same output):

The renderer resolves this component as a native block; the preview above is its real HTML output, and Markdown parity for native blocks is covered by the renderer test suite.

## Specification

Generated from `packages/contracts/component-specs/video.md`.

### Contract

Production props are normative in `../contracts/component-props/video.schema.json`. The corresponding `component-fixtures` manifest is only a minimal protocol fixture; use the production props schema when building the published package. The packaged artifact ships exactly its generated `component-package.json` manifest plus `props.schema.json` (the production props schema, copied byte-for-byte) and `spec.md` (this spec, copied byte-for-byte); it contains no executable payload, fallback implementation, Storybook, test suite, SSR harness or README. Rendering behavior and the acceptance cases below belong to the renderer and the repository tests, not to the package. Installation pins the package version and the digest of every shipped byte.

### Intended behavior

Controls, captions and transcript; no autoplay sound; render from verified media store.

### Failure and fallback

Unavailable media preserves transcript when permitted.

### Required acceptance cases

Captions correct association; keyboard and reduced-motion. Also test empty data, loading, denied access, browser without JS, mobile 360px, keyboard navigation, dark mode and an explicit constrained agent tool call. The server independently authorizes capability requests; a package manifest cannot grant authority.

### Data and maintenance

Data bindings resolve from a specific publication/release vector and permitted fact/evidence graph. Configuration edits create versioned component patches. Update invalidation uses dependency IDs, never indiscriminate whole-page regeneration. Human-owned props survive automatic updates unless invalidated with an explicit conflict. Missing optional resources leave an honest inert/readable fallback, not a broken page or fake success.

### Cost and tools

Pure/local interaction must never invoke a model by accident. Any model, remote query or executor call must reserve approved budget before dispatch. Public visitors do not inherit owner resources. The component may call only named tools in its signed manifest with valid typed inputs. A cancelled job stops polling and closes resources. No component gets platform administration, raw credentials or an unlimited execution loop.

## Package manifest

Protocol fixture: `packages/contracts/component-fixtures/video.json`.

| Field | Value |
| --- | --- |
| Name | @docsloth/video |
| Version | 1.0.0 |
| Protocol | 1.x |
| License | Apache-2.0 |
| Runtime | react |
| Entry | dist/index.js |
| Recording policy | masked |
| Fallback | html, markdown, json |
| Network hosts | none |
| Production write | no |
| Max runtime seconds | 0 |
| Integrity | all zeros (protocol fixture placeholder) |

| Tool | Effect | Confirmation | Input |
| --- | --- | --- | --- |
| play | read | no | value |
| pause | read | no | value |
| seek | read | no | value |

## Sources

| Source | Path |
| --- | --- |
| Component page | https://registry.docsloth.dev/components/video.html |
| Markdown twin | https://registry.docsloth.dev/docs/video.md |
| LLM index | https://registry.docsloth.dev/llms.txt |
| Specification | packages/contracts/component-specs/video.md |
| Prop schema | packages/contracts/component-props/video.schema.json |
| Protocol fixture | packages/contracts/component-fixtures/video.json |
| Catalog | packages/contracts/component-catalog.json |


---

# gif

Short annotated motion with static alternative

| Field | Value |
| --- | --- |
| Trust class | pure |
| Implementation status | implemented_native |
| Renderer | native block |
| Key prop (production schema) | asset_id |
| Key prop (protocol fixture) | src |
| Tools | none |
| Package version | 1.0.0 |
| Package digest | sha256:deb4d9079a20d46fa79ee349b1a5b52b56f9186bf1d147a6c543a2dc954b50f6 |

## Install

```sh
docsloth component add @docsloth/gif@1.0.0
```

Live package: sha256:deb4d9079a20d46fa79ee349b1a5b52b56f9186bf1d147a6c543a2dc954b50f6 with 2 file digest(s); the catalog entry is generated from the built package, not a placeholder.

## Props

The prop schema is normative in `packages/contracts/component-props/gif.schema.json`.

| Prop | Type | Required | Constraints |
| --- | --- | --- | --- |
| `title` | string | no | maxLength: 160 |
| `asset_id` | string | yes | format: uuid |
| `static_asset_id` | string | yes | format: uuid |
| `alt` | string | yes |  |
| `caption` | string | no |  |

Example props generated from this schema:

```json
{
  "title": "example-title",
  "asset_id": "00000000-0000-4000-8000-000000000000",
  "static_asset_id": "00000000-0000-4000-8000-000000000000",
  "alt": "example-alt",
  "caption": "example-caption"
}
```

Required props: asset_id, static_asset_id, alt.

## Example

Example document IR (the block the renderer consumes):

```json
{
  "type": "gif",
  "props": {
    "title": "example-title",
    "asset_id": "00000000-0000-4000-8000-000000000000",
    "static_asset_id": "00000000-0000-4000-8000-000000000000",
    "alt": "example-alt",
    "caption": "example-caption"
  }
}
```

Renderer HTML (entities decoded and wrapped for display):

```html
<section class="ds-block ds-gif" data-component="gif" aria-labelledby="b-title">
<h3 class="ds-block-title" id="b-title">example-title</h3>
<p>example-alt</p>
<p>example-caption</p>
<p class="ds-live-note" role="note">The animation is served by the live documentation site.</p>
</section>
```

Preview (interface-only; the markup above is the same output):

The renderer resolves this component as a native block; the preview above is its real HTML output, and Markdown parity for native blocks is covered by the renderer test suite.

## Specification

Generated from `packages/contracts/component-specs/gif.md`.

### Contract

Production props are normative in `../contracts/component-props/gif.schema.json`. The corresponding `component-fixtures` manifest is only a minimal protocol fixture; use the production props schema when building the published package. The packaged artifact ships exactly its generated `component-package.json` manifest plus `props.schema.json` (the production props schema, copied byte-for-byte) and `spec.md` (this spec, copied byte-for-byte); it contains no executable payload, fallback implementation, Storybook, test suite, SSR harness or README. Rendering behavior and the acceptance cases below belong to the renderer and the repository tests, not to the package. Installation pins the package version and the digest of every shipped byte.

### Intended behavior

Short annotated animation with pause/static mode and reduced-motion fallback.

### Failure and fallback

Unreadable asset uses alt/caption rather than broken-image-only.

### Required acceptance cases

No sensitive screenshot or metadata in published file. Also test empty data, loading, denied access, browser without JS, mobile 360px, keyboard navigation, dark mode and an explicit constrained agent tool call. The server independently authorizes capability requests; a package manifest cannot grant authority.

### Data and maintenance

Data bindings resolve from a specific publication/release vector and permitted fact/evidence graph. Configuration edits create versioned component patches. Update invalidation uses dependency IDs, never indiscriminate whole-page regeneration. Human-owned props survive automatic updates unless invalidated with an explicit conflict. Missing optional resources leave an honest inert/readable fallback, not a broken page or fake success.

### Cost and tools

Pure/local interaction must never invoke a model by accident. Any model, remote query or executor call must reserve approved budget before dispatch. Public visitors do not inherit owner resources. The component may call only named tools in its signed manifest with valid typed inputs. A cancelled job stops polling and closes resources. No component gets platform administration, raw credentials or an unlimited execution loop.

## Package manifest

Protocol fixture: `packages/contracts/component-fixtures/gif.json`.

| Field | Value |
| --- | --- |
| Name | @docsloth/gif |
| Version | 1.0.0 |
| Protocol | 1.x |
| License | Apache-2.0 |
| Runtime | react |
| Entry | dist/index.js |
| Recording policy | masked |
| Fallback | html, markdown, json |
| Network hosts | none |
| Production write | no |
| Max runtime seconds | 0 |
| Integrity | all zeros (protocol fixture placeholder) |

## Sources

| Source | Path |
| --- | --- |
| Component page | https://registry.docsloth.dev/components/gif.html |
| Markdown twin | https://registry.docsloth.dev/docs/gif.md |
| LLM index | https://registry.docsloth.dev/llms.txt |
| Specification | packages/contracts/component-specs/gif.md |
| Prop schema | packages/contracts/component-props/gif.schema.json |
| Protocol fixture | packages/contracts/component-fixtures/gif.json |
| Catalog | packages/contracts/component-catalog.json |


---

# image

Accessible versioned screenshot

| Field | Value |
| --- | --- |
| Trust class | pure |
| Implementation status | implemented_native |
| Renderer | native block |
| Key prop (production schema) | asset_id |
| Key prop (protocol fixture) | src |
| Tools | none |
| Package version | 1.0.0 |
| Package digest | sha256:916c97ac0ee5c5bc181e44f39dbb220539637a39b0557e29f824a34c72011e29 |

## Install

```sh
docsloth component add @docsloth/image@1.0.0
```

Live package: sha256:916c97ac0ee5c5bc181e44f39dbb220539637a39b0557e29f824a34c72011e29 with 2 file digest(s); the catalog entry is generated from the built package, not a placeholder.

## Props

The prop schema is normative in `packages/contracts/component-props/image.schema.json`.

| Prop | Type | Required | Constraints |
| --- | --- | --- | --- |
| `title` | string | no | maxLength: 160 |
| `asset_id` | string | yes | format: uuid |
| `alt` | string | yes |  |
| `caption` | string | no |  |
| `decorative` | boolean | yes |  |

Example props generated from this schema:

```json
{
  "title": "example-title",
  "asset_id": "00000000-0000-4000-8000-000000000000",
  "alt": "example-alt",
  "caption": "example-caption",
  "decorative": true
}
```

Required props: asset_id, alt, decorative.

## Example

Example document IR (the block the renderer consumes):

```json
{
  "type": "image",
  "props": {
    "title": "example-title",
    "asset_id": "00000000-0000-4000-8000-000000000000",
    "alt": "example-alt",
    "caption": "example-caption",
    "decorative": true
  }
}
```

Renderer HTML (entities decoded and wrapped for display):

```html
<section class="ds-block ds-image" data-component="image" aria-labelledby="b-title">
<h3 class="ds-block-title" id="b-title">example-title</h3>
<p>example-caption</p>
</section>
```

Preview (interface-only; the markup above is the same output):

The renderer resolves this component as a native block; the preview above is its real HTML output, and Markdown parity for native blocks is covered by the renderer test suite.

## Specification

Generated from `packages/contracts/component-specs/image.md`.

### Contract

Production props are normative in `../contracts/component-props/image.schema.json`. The corresponding `component-fixtures` manifest is only a minimal protocol fixture; use the production props schema when building the published package. The packaged artifact ships exactly its generated `component-package.json` manifest plus `props.schema.json` (the production props schema, copied byte-for-byte) and `spec.md` (this spec, copied byte-for-byte); it contains no executable payload, fallback implementation, Storybook, test suite, SSR harness or README. Rendering behavior and the acceptance cases below belong to the renderer and the repository tests, not to the package. Installation pins the package version and the digest of every shipped byte.

### Intended behavior

Responsive intrinsic dimensions, correct alt, no capture of live private UI as public source.

### Failure and fallback

Alt required unless decorative.

### Required acceptance cases

Layout shift avoided; private media references blocked. Also test empty data, loading, denied access, browser without JS, mobile 360px, keyboard navigation, dark mode and an explicit constrained agent tool call. The server independently authorizes capability requests; a package manifest cannot grant authority.

### Data and maintenance

Data bindings resolve from a specific publication/release vector and permitted fact/evidence graph. Configuration edits create versioned component patches. Update invalidation uses dependency IDs, never indiscriminate whole-page regeneration. Human-owned props survive automatic updates unless invalidated with an explicit conflict. Missing optional resources leave an honest inert/readable fallback, not a broken page or fake success.

### Cost and tools

Pure/local interaction must never invoke a model by accident. Any model, remote query or executor call must reserve approved budget before dispatch. Public visitors do not inherit owner resources. The component may call only named tools in its signed manifest with valid typed inputs. A cancelled job stops polling and closes resources. No component gets platform administration, raw credentials or an unlimited execution loop.

## Package manifest

Protocol fixture: `packages/contracts/component-fixtures/image.json`.

| Field | Value |
| --- | --- |
| Name | @docsloth/image |
| Version | 1.0.0 |
| Protocol | 1.x |
| License | Apache-2.0 |
| Runtime | react |
| Entry | dist/index.js |
| Recording policy | masked |
| Fallback | html, markdown, json |
| Network hosts | none |
| Production write | no |
| Max runtime seconds | 0 |
| Integrity | all zeros (protocol fixture placeholder) |

## Sources

| Source | Path |
| --- | --- |
| Component page | https://registry.docsloth.dev/components/image.html |
| Markdown twin | https://registry.docsloth.dev/docs/image.md |
| LLM index | https://registry.docsloth.dev/llms.txt |
| Specification | packages/contracts/component-specs/image.md |
| Prop schema | packages/contracts/component-props/image.schema.json |
| Protocol fixture | packages/contracts/component-fixtures/image.json |
| Catalog | packages/contracts/component-catalog.json |


---

# release-timeline

Published version and migration history

| Field | Value |
| --- | --- |
| Trust class | interactive |
| Implementation status | implemented_native |
| Renderer | native block |
| Key prop (production schema) | software_id |
| Key prop (protocol fixture) | releaseId |
| Tools | select_version |
| Package version | 1.0.0 |
| Package digest | sha256:4f0e51678b85f7625cfdd02b8cf87285be9b480d6eab3ccca38d1d1e44c500d9 |

## Install

```sh
docsloth component add @docsloth/release-timeline@1.0.0
```

Live package: sha256:4f0e51678b85f7625cfdd02b8cf87285be9b480d6eab3ccca38d1d1e44c500d9 with 2 file digest(s); the catalog entry is generated from the built package, not a placeholder.

## Props

The prop schema is normative in `packages/contracts/component-props/release-timeline.schema.json`.

| Prop | Type | Required | Constraints |
| --- | --- | --- | --- |
| `title` | string | no | maxLength: 160 |
| `software_id` | string | yes | format: uuid |
| `channel` | string | yes |  |
| `max_items` | integer | yes |  |

Example props generated from this schema:

```json
{
  "title": "example-title",
  "software_id": "00000000-0000-4000-8000-000000000000",
  "channel": "example-channel",
  "max_items": 1
}
```

Required props: software_id, channel, max_items.

## Example

Example document IR (the block the renderer consumes):

```json
{
  "type": "release-timeline",
  "props": {
    "title": "example-title",
    "software_id": "00000000-0000-4000-8000-000000000000",
    "channel": "example-channel",
    "max_items": 1
  }
}
```

Renderer HTML (entities decoded and wrapped for display):

```html
<section class="ds-block ds-release-timeline" data-component="release-timeline" aria-labelledby="b-title">
<h3 class="ds-block-title" id="b-title">example-title</h3>
<p>Published releases on the <code>example-channel</code> channel, newest 1 first.</p>
<p class="ds-live-note" role="note">Published releases are not available without an authorized release-history binding.</p>
</section>
```

Preview (interface-only; the markup above is the same output):

The renderer resolves this component as a native block; the preview above is its real HTML output, and Markdown parity for native blocks is covered by the renderer test suite.

## Specification

Generated from `packages/contracts/component-specs/release-timeline.md`.

### Contract

Production props are normative in `../contracts/component-props/release-timeline.schema.json`. The corresponding `component-fixtures` manifest is only a minimal protocol fixture; use the production props schema when building the published package. The packaged artifact ships exactly its generated `component-package.json` manifest plus `props.schema.json` (the production props schema, copied byte-for-byte) and `spec.md` (this spec, copied byte-for-byte); it contains no executable payload, fallback implementation, Storybook, test suite, SSR harness or README. Rendering behavior and the acceptance cases below belong to the renderer and the repository tests, not to the package. Installation pins the package version and the digest of every shipped byte.

### Intended behavior

The React renderer resolves production `software_id` and `channel` through the release-scoped `ComponentContentProvider.releaseTimelines` nested readonly map. Hosts supply only history already authorized for this audience. Available entries carry `id`, `state`, `version`, UTC ISO `published_at` and optional `summary`, `href`, `migration_href`. Only `state: published` renders; entries sort newest first (ID breaks timestamp ties), limited by production `max_items` (1–100). The complete rendered list, UTC dates, release links and migration links work without JavaScript. Text is escaped and links must pass web-navigation validation. No clipboard, fetch, model or executor call is part of this component. Host maps are immutable snapshots; replace them when release state changes. This renderer does not establish publication truth or audience access.

### Failure and fallback

Missing/invalid bindings render an explicit unavailable empty timeline; an available empty set states that no published releases exist. `access: loading` shows loading, and `access: restricted` shows no record details even if supplied. A binding has at most 1,000 entries; published IDs are unique and nonempty, versions are bounded to 160 characters, summaries to 2,000, links to 4,096, and combined record text to 2,000,000. Invalid published dates or records refuse the binding. Host authorization, engine/cloud history delivery and agent-tool dispatch remain integration work.

### Required acceptance cases

Actual production vector consistency. Also test empty data, loading, denied access, browser without JS, mobile 360px, keyboard navigation, dark mode and an explicit constrained agent tool call. The server independently authorizes capability requests; a package manifest cannot grant authority.

### Data and maintenance

Data bindings resolve from a specific publication/release vector and permitted fact/evidence graph. Configuration edits create versioned component patches. Update invalidation uses dependency IDs, never indiscriminate whole-page regeneration. Human-owned props survive automatic updates unless invalidated with an explicit conflict. Missing optional resources leave an honest inert/readable fallback, not a broken page or fake success.

### Cost and tools

Pure/local interaction must never invoke a model by accident. Any model, remote query or executor call must reserve approved budget before dispatch. Public visitors do not inherit owner resources. The component may call only named tools in its signed manifest with valid typed inputs. A cancelled job stops polling and closes resources. No component gets platform administration, raw credentials or an unlimited execution loop.

## Package manifest

Protocol fixture: `packages/contracts/component-fixtures/release-timeline.json`.

| Field | Value |
| --- | --- |
| Name | @docsloth/release-timeline |
| Version | 1.0.0 |
| Protocol | 1.x |
| License | Apache-2.0 |
| Runtime | react |
| Entry | dist/index.js |
| Recording policy | masked |
| Fallback | html, markdown, json |
| Network hosts | none |
| Production write | no |
| Max runtime seconds | 0 |
| Integrity | all zeros (protocol fixture placeholder) |

| Tool | Effect | Confirmation | Input |
| --- | --- | --- | --- |
| select_version | read | no | value |

## Sources

| Source | Path |
| --- | --- |
| Component page | https://registry.docsloth.dev/components/release-timeline.html |
| Markdown twin | https://registry.docsloth.dev/docs/release-timeline.md |
| LLM index | https://registry.docsloth.dev/llms.txt |
| Specification | packages/contracts/component-specs/release-timeline.md |
| Prop schema | packages/contracts/component-props/release-timeline.schema.json |
| Protocol fixture | packages/contracts/component-fixtures/release-timeline.json |
| Catalog | packages/contracts/component-catalog.json |


---

# migration

Before-and-after change guide

| Field | Value |
| --- | --- |
| Trust class | interactive |
| Implementation status | implemented_native |
| Renderer | native block |
| Key prop (production schema) | from_snapshot_id |
| Key prop (protocol fixture) | fromVersion |
| Tools | compare |
| Package version | 1.0.0 |
| Package digest | sha256:1e33029c22b4ace4d3075af9616a8be440342cf130e8c8ffed5e1bde7fde19c0 |

## Install

```sh
docsloth component add @docsloth/migration@1.0.0
```

Live package: sha256:1e33029c22b4ace4d3075af9616a8be440342cf130e8c8ffed5e1bde7fde19c0 with 2 file digest(s); the catalog entry is generated from the built package, not a placeholder.

## Props

The prop schema is normative in `packages/contracts/component-props/migration.schema.json`.

| Prop | Type | Required | Constraints |
| --- | --- | --- | --- |
| `title` | string | no | maxLength: 160 |
| `from_snapshot_id` | string | yes | format: uuid |
| `to_snapshot_id` | string | yes | format: uuid |
| `breaking_fact_ids` | array<string> | yes |  |
| `steps` | array<string> | yes |  |

Example props generated from this schema:

```json
{
  "title": "example-title",
  "from_snapshot_id": "00000000-0000-4000-8000-000000000000",
  "to_snapshot_id": "00000000-0000-4000-8000-000000000000",
  "breaking_fact_ids": [
    "00000000-0000-4000-8000-000000000000"
  ],
  "steps": [
    "example-steps"
  ]
}
```

Required props: from_snapshot_id, to_snapshot_id, breaking_fact_ids, steps.

## Example

Example document IR (the block the renderer consumes):

```json
{
  "type": "migration",
  "props": {
    "title": "example-title",
    "from_snapshot_id": "00000000-0000-4000-8000-000000000000",
    "to_snapshot_id": "00000000-0000-4000-8000-000000000000",
    "breaking_fact_ids": [
      "00000000-0000-4000-8000-000000000000"
    ],
    "steps": [
      "example-steps"
    ]
  }
}
```

Renderer HTML (entities decoded and wrapped for display):

```html
<section class="ds-block ds-migration" data-component="migration" aria-labelledby="b-title">
<h3 class="ds-block-title" id="b-title">example-title</h3>
<p>1 breaking change is recorded for this migration.</p>
<ol class="ds-list">
<li>example-steps</li>
</ol>
</section>
```

Preview (interface-only; the markup above is the same output):

The renderer resolves this component as a native block; the preview above is its real HTML output, and Markdown parity for native blocks is covered by the renderer test suite.

## Specification

Generated from `packages/contracts/component-specs/migration.md`.

### Contract

Production props are normative in `../contracts/component-props/migration.schema.json`. The corresponding `component-fixtures` manifest is only a minimal protocol fixture; use the production props schema when building the published package. The packaged artifact ships exactly its generated `component-package.json` manifest plus `props.schema.json` (the production props schema, copied byte-for-byte) and `spec.md` (this spec, copied byte-for-byte); it contains no executable payload, fallback implementation, Storybook, test suite, SSR harness or README. Rendering behavior and the acceptance cases below belong to the renderer and the repository tests, not to the package. Installation pins the package version and the digest of every shipped byte.

### Intended behavior

Side-by-side validated changes, impacts, prerequisites, rollbacks and action-required warning.

### Failure and fallback

Unverified migration steps explicitly not_run and block auto-publication if required.

### Required acceptance cases

Old and new examples execute against corresponding fixtures. Also test empty data, loading, denied access, browser without JS, mobile 360px, keyboard navigation, dark mode and an explicit constrained agent tool call. The server independently authorizes capability requests; a package manifest cannot grant authority.

### Data and maintenance

Data bindings resolve from a specific publication/release vector and permitted fact/evidence graph. Configuration edits create versioned component patches. Update invalidation uses dependency IDs, never indiscriminate whole-page regeneration. Human-owned props survive automatic updates unless invalidated with an explicit conflict. Missing optional resources leave an honest inert/readable fallback, not a broken page or fake success.

### Cost and tools

Pure/local interaction must never invoke a model by accident. Any model, remote query or executor call must reserve approved budget before dispatch. Public visitors do not inherit owner resources. The component may call only named tools in its signed manifest with valid typed inputs. A cancelled job stops polling and closes resources. No component gets platform administration, raw credentials or an unlimited execution loop.

## Package manifest

Protocol fixture: `packages/contracts/component-fixtures/migration.json`.

| Field | Value |
| --- | --- |
| Name | @docsloth/migration |
| Version | 1.0.0 |
| Protocol | 1.x |
| License | Apache-2.0 |
| Runtime | react |
| Entry | dist/index.js |
| Recording policy | masked |
| Fallback | html, markdown, json |
| Network hosts | none |
| Production write | no |
| Max runtime seconds | 0 |
| Integrity | all zeros (protocol fixture placeholder) |

| Tool | Effect | Confirmation | Input |
| --- | --- | --- | --- |
| compare | read | no | value |

## Sources

| Source | Path |
| --- | --- |
| Component page | https://registry.docsloth.dev/components/migration.html |
| Markdown twin | https://registry.docsloth.dev/docs/migration.md |
| LLM index | https://registry.docsloth.dev/llms.txt |
| Specification | packages/contracts/component-specs/migration.md |
| Prop schema | packages/contracts/component-props/migration.schema.json |
| Protocol fixture | packages/contracts/component-fixtures/migration.json |
| Catalog | packages/contracts/component-catalog.json |


---

# permissions

Read-only permission matrix

| Field | Value |
| --- | --- |
| Trust class | interactive |
| Implementation status | implemented_native |
| Renderer | native block |
| Key prop (production schema) | policy_id |
| Key prop (protocol fixture) | policyId |
| Tools | filter |
| Package version | 1.0.0 |
| Package digest | sha256:4723e1b392af90ca6866c823f5273b33bdb47bfbf077234ddcf70bed8936e5c7 |

## Install

```sh
docsloth component add @docsloth/permissions@1.0.0
```

Live package: sha256:4723e1b392af90ca6866c823f5273b33bdb47bfbf077234ddcf70bed8936e5c7 with 2 file digest(s); the catalog entry is generated from the built package, not a placeholder.

## Props

The prop schema is normative in `packages/contracts/component-props/permissions.schema.json`.

| Prop | Type | Required | Constraints |
| --- | --- | --- | --- |
| `title` | string | no | maxLength: 160 |
| `policy_id` | string | yes | format: uuid |
| `roles` | array<string> | yes |  |
| `actions` | array<string> | yes |  |
| `matrix` | array<object> | yes |  |

Example props generated from this schema:

```json
{
  "title": "example-title",
  "policy_id": "00000000-0000-4000-8000-000000000000",
  "roles": [
    "example-roles"
  ],
  "actions": [
    "example-actions"
  ],
  "matrix": [
    {
      "key": "example-key",
      "cells": [
        "example-cells"
      ]
    }
  ]
}
```

Required props: policy_id, roles, actions, matrix.

## Example

Example document IR (the block the renderer consumes):

```json
{
  "type": "permissions",
  "props": {
    "title": "example-title",
    "policy_id": "00000000-0000-4000-8000-000000000000",
    "roles": [
      "example-roles"
    ],
    "actions": [
      "example-actions"
    ],
    "matrix": [
      {
        "key": "example-key",
        "cells": [
          "example-cells"
        ]
      }
    ]
  }
}
```

Renderer HTML (entities decoded and wrapped for display):

```html
<section class="ds-block ds-permissions" data-component="permissions" aria-labelledby="b-title">
<h3 class="ds-block-title" id="b-title">example-title</h3>
<table class="ds-table">
<caption>Permissions by role</caption>
<thead>
<tr>
<th scope="col">Action</th>
<th scope="col">example-roles</th>
</tr>
</thead>
<tbody>
<tr>
<th scope="row">example-key</th>
<td>example-cells</td>
</tr>
</tbody>
</table>
<dl class="ds-facts">
<div>
<dt>Actions without a row</dt>
<dd>
<code>example-actions</code>
</dd>
</div>
</dl>
</section>
```

Preview (interface-only; the markup above is the same output):

The renderer resolves this component as a native block; the preview above is its real HTML output, and Markdown parity for native blocks is covered by the renderer test suite.

## Specification

Generated from `packages/contracts/component-specs/permissions.md`.

### Contract

Production props are normative in `../contracts/component-props/permissions.schema.json`. The corresponding `component-fixtures` manifest is only a minimal protocol fixture; use the production props schema when building the published package. The packaged artifact ships exactly its generated `component-package.json` manifest plus `props.schema.json` (the production props schema, copied byte-for-byte) and `spec.md` (this spec, copied byte-for-byte); it contains no executable payload, fallback implementation, Storybook, test suite, SSR harness or README. Rendering behavior and the acceptance cases below belong to the renderer and the repository tests, not to the package. Installation pins the package version and the digest of every shipped byte.

### Intended behavior

Read-only approved role/action matrix, distinguishes docs visibility from software privileges.

### Failure and fallback

Unknown permission cannot default allow.

### Required acceptance cases

Matrix matches policy fixture and accessible table. Also test empty data, loading, denied access, browser without JS, mobile 360px, keyboard navigation, dark mode and an explicit constrained agent tool call. The server independently authorizes capability requests; a package manifest cannot grant authority.

### Data and maintenance

Data bindings resolve from a specific publication/release vector and permitted fact/evidence graph. Configuration edits create versioned component patches. Update invalidation uses dependency IDs, never indiscriminate whole-page regeneration. Human-owned props survive automatic updates unless invalidated with an explicit conflict. Missing optional resources leave an honest inert/readable fallback, not a broken page or fake success.

### Cost and tools

Pure/local interaction must never invoke a model by accident. Any model, remote query or executor call must reserve approved budget before dispatch. Public visitors do not inherit owner resources. The component may call only named tools in its signed manifest with valid typed inputs. A cancelled job stops polling and closes resources. No component gets platform administration, raw credentials or an unlimited execution loop.

## Package manifest

Protocol fixture: `packages/contracts/component-fixtures/permissions.json`.

| Field | Value |
| --- | --- |
| Name | @docsloth/permissions |
| Version | 1.0.0 |
| Protocol | 1.x |
| License | Apache-2.0 |
| Runtime | react |
| Entry | dist/index.js |
| Recording policy | masked |
| Fallback | html, markdown, json |
| Network hosts | none |
| Production write | no |
| Max runtime seconds | 0 |
| Integrity | all zeros (protocol fixture placeholder) |

| Tool | Effect | Confirmation | Input |
| --- | --- | --- | --- |
| filter | read | no | value |

## Sources

| Source | Path |
| --- | --- |
| Component page | https://registry.docsloth.dev/components/permissions.html |
| Markdown twin | https://registry.docsloth.dev/docs/permissions.md |
| LLM index | https://registry.docsloth.dev/llms.txt |
| Specification | packages/contracts/component-specs/permissions.md |
| Prop schema | packages/contracts/component-props/permissions.schema.json |
| Protocol fixture | packages/contracts/component-fixtures/permissions.json |
| Catalog | packages/contracts/component-catalog.json |


---

# configurator

Prepare safe software configuration

| Field | Value |
| --- | --- |
| Trust class | connected |
| Implementation status | implemented_native |
| Renderer | native block |
| Key prop (production schema) | schema_ref |
| Key prop (protocol fixture) | schemaId |
| Tools | validate, export |
| Package version | 1.0.0 |
| Package digest | sha256:97c8deb6cdb1b9547d963504aaf0908d2048a07e478a7e88601d1ba07854bf90 |

## Install

```sh
docsloth component add @docsloth/configurator@1.0.0
```

Live package: sha256:97c8deb6cdb1b9547d963504aaf0908d2048a07e478a7e88601d1ba07854bf90 with 2 file digest(s); the catalog entry is generated from the built package, not a placeholder.

## Props

The prop schema is normative in `packages/contracts/component-props/configurator.schema.json`.

| Prop | Type | Required | Constraints |
| --- | --- | --- | --- |
| `title` | string | no | maxLength: 160 |
| `schema_ref` | string | yes | maxLength: 256 |
| `resource` | object | no | additionalProperties: false |
| `resource.resource_id` | string | yes | format: uuid |
| `resource.operation` | string | yes | maxLength: 160 |
| `resource.environment` | "test" \| "staging" \| "production" | yes |  |
| `output_format` | "yaml" \| "json" \| "env" | yes |  |
| `safe_defaults` | object | yes |  |

Example props generated from this schema:

```json
{
  "title": "example-title",
  "schema_ref": "example-schema_ref",
  "resource": {
    "resource_id": "00000000-0000-4000-8000-000000000000",
    "operation": "example-operation",
    "environment": "test"
  },
  "output_format": "yaml",
  "safe_defaults": {}
}
```

Required props: schema_ref, output_format, safe_defaults.

## Example

Example document IR (the block the renderer consumes):

```json
{
  "type": "configurator",
  "props": {
    "title": "example-title",
    "schema_ref": "example-schema_ref",
    "resource": {
      "resource_id": "00000000-0000-4000-8000-000000000000",
      "operation": "example-operation",
      "environment": "test"
    },
    "output_format": "yaml",
    "safe_defaults": {}
  }
}
```

Renderer HTML (entities decoded and wrapped for display):

```html
<section class="ds-block ds-configurator" data-component="configurator" aria-labelledby="b-title">
<h3 class="ds-block-title" id="b-title">example-title</h3>
<dl class="ds-facts">
<div>
<dt>Schema</dt>
<dd>
<code>example-schema_ref</code>
</dd>
</div>
<div>
<dt>Runs</dt>
<dd>
<code>example-operation</code> in the test environment</dd>
</div>
</dl>
<p class="ds-code-caption">Safe defaults</p>
<pre class="ds-code" data-lang="yaml">
<code>{}</code>
</pre>
<p class="ds-live-note" role="note">Editing, validating and exporting this configuration needs the live documentation site.</p>
</section>
```

Preview (interface-only; the markup above is the same output):

The renderer resolves this component as a native block; the preview above is its real HTML output, and Markdown parity for native blocks is covered by the renderer test suite.

## Specification

Generated from `packages/contracts/component-specs/configurator.md`.

### Contract

Production props are normative in `../contracts/component-props/configurator.schema.json`. The corresponding `component-fixtures` manifest is only a minimal protocol fixture; use the production props schema when building the published package. The packaged artifact ships exactly its generated `component-package.json` manifest plus `props.schema.json` (the production props schema, copied byte-for-byte) and `spec.md` (this spec, copied byte-for-byte); it contains no executable payload, fallback implementation, Storybook, test suite, SSR harness or README. Rendering behavior and the acceptance cases below belong to the renderer and the repository tests, not to the package. Installation pins the package version and the digest of every shipped byte.

### Intended behavior

Generate copy/download configuration with unresolved secret references clearly marked.

### Failure and fallback

No provider selected means unresolved config, not bogus working tokens.

### Required acceptance cases

Secrets never serialized; escaping prevents code injection. Also test empty data, loading, denied access, browser without JS, mobile 360px, keyboard navigation, dark mode and an explicit constrained agent tool call. The server independently authorizes capability requests; a package manifest cannot grant authority.

### Data and maintenance

Data bindings resolve from a specific publication/release vector and permitted fact/evidence graph. Configuration edits create versioned component patches. Update invalidation uses dependency IDs, never indiscriminate whole-page regeneration. Human-owned props survive automatic updates unless invalidated with an explicit conflict. Missing optional resources leave an honest inert/readable fallback, not a broken page or fake success.

### Cost and tools

Pure/local interaction must never invoke a model by accident. Any model, remote query or executor call must reserve approved budget before dispatch. Public visitors do not inherit owner resources. The component may call only named tools in its signed manifest with valid typed inputs. A cancelled job stops polling and closes resources. No component gets platform administration, raw credentials or an unlimited execution loop.

### React host binding

The host provides `configurators` keyed by `configuratorKey(schema_ref, resource ?? null, output_format)`. An available record pins release, schema reference/version, session, resource operation/environment (or null), and output format. The schema is delivered only after audience authorization; missing, loading, restricted and mismatched bindings expose no configuration fields. This renderer does not invoke the manifest's remote tools or generic executors. Any separately implemented agent tool must be authorized per call and budgeted by its host; denials use `permission_required`.

The local form supports bounded flat scalar JSON Schema fields, required fields, enums, constants, numeric ranges and string lengths. Unsupported constraints fail closed. Production `safe_defaults` override ordinary schema defaults; unknown fields and invalid scalar types refuse. Schema/default changes reset the draft. Fields marked `writeOnly`, `format: password` or recognized common credential names have no input: their defaults are discarded and exports contain synthetic `${DOCSLOTH_SECRET_n}` unresolved references. The host must correctly classify all secret fields before delivery; name detection is only a fallback and cannot identify an arbitrary credential hidden in an ordinary text field. No credentials belong in props or schema.

The preview and clipboard/download contain identical local bytes. JSON uses native serialization; YAML uses quoted JSON keys/scalars (YAML 1.2 compatible). `env` emits **POSIX shell assignments**, with literal single-quote escaping; it is not a universal dotenv dialect. Invalid shell variable names and NUL values refuse. Draft input and output are bounded; exports cannot exceed 128 KiB. No generated text is executed, applied or persisted by this renderer. Without a selected provider or resolved secrets, the template explicitly makes no working-connection claim.

No-JavaScript defaults and preview remain readable with disabled controls. Clipboard denial retains manual selection; download errors are visible. Scope/access/default/schema replacement removes prior draft state and suppresses late clipboard status. Host schema retrieval, server access control, secret resolution and versioned persistence of any applied component patch remain integration responsibilities.

## Package manifest

Protocol fixture: `packages/contracts/component-fixtures/configurator.json`.

| Field | Value |
| --- | --- |
| Name | @docsloth/configurator |
| Version | 1.0.0 |
| Protocol | 1.x |
| License | Apache-2.0 |
| Runtime | react |
| Entry | dist/index.js |
| Recording policy | blocked |
| Fallback | html, markdown, json |
| Network hosts | none |
| Production write | no |
| Max runtime seconds | 120 |
| Integrity | all zeros (protocol fixture placeholder) |

| Tool | Effect | Confirmation | Input |
| --- | --- | --- | --- |
| validate | execute | no | value |
| export | read | no | value |

## Sources

| Source | Path |
| --- | --- |
| Component page | https://registry.docsloth.dev/components/configurator.html |
| Markdown twin | https://registry.docsloth.dev/docs/configurator.md |
| LLM index | https://registry.docsloth.dev/llms.txt |
| Specification | packages/contracts/component-specs/configurator.md |
| Prop schema | packages/contracts/component-props/configurator.schema.json |
| Protocol fixture | packages/contracts/component-fixtures/configurator.json |
| Catalog | packages/contracts/component-catalog.json |


---

# webhook-debugger

Inspect synthetic approved webhook delivery

| Field | Value |
| --- | --- |
| Trust class | connected |
| Implementation status | implemented_native |
| Renderer | native block |
| Key prop (production schema) | event_schema_ref |
| Key prop (protocol fixture) | eventType |
| Tools | simulate, inspect |
| Package version | 1.0.0 |
| Package digest | sha256:84dab19a37c1a8b2a5186de45fd2d13b0d19c9460cc8553fbe8a891b44220b1f |

## Install

```sh
docsloth component add @docsloth/webhook-debugger@1.0.0
```

Live package: sha256:84dab19a37c1a8b2a5186de45fd2d13b0d19c9460cc8553fbe8a891b44220b1f with 2 file digest(s); the catalog entry is generated from the built package, not a placeholder.

## Props

The prop schema is normative in `packages/contracts/component-props/webhook-debugger.schema.json`.

| Prop | Type | Required | Constraints |
| --- | --- | --- | --- |
| `title` | string | no | maxLength: 160 |
| `event_schema_ref` | string | yes | maxLength: 256 |
| `resource` | object | no | additionalProperties: false |
| `resource.resource_id` | string | yes | format: uuid |
| `resource.operation` | string | yes | maxLength: 160 |
| `resource.environment` | "test" \| "staging" \| "production" | yes |  |
| `synthetic_only` | boolean | yes |  |
| `max_events` | integer | yes |  |

Example props generated from this schema:

```json
{
  "title": "example-title",
  "event_schema_ref": "example-event_schema_ref",
  "resource": {
    "resource_id": "00000000-0000-4000-8000-000000000000",
    "operation": "example-operation",
    "environment": "test"
  },
  "synthetic_only": true,
  "max_events": 1
}
```

Required props: event_schema_ref, synthetic_only, max_events.

## Example

Example document IR (the block the renderer consumes):

```json
{
  "type": "webhook-debugger",
  "props": {
    "title": "example-title",
    "event_schema_ref": "example-event_schema_ref",
    "resource": {
      "resource_id": "00000000-0000-4000-8000-000000000000",
      "operation": "example-operation",
      "environment": "test"
    },
    "synthetic_only": true,
    "max_events": 1
  }
}
```

Renderer HTML (entities decoded and wrapped for display):

```html
<section class="ds-block ds-webhook-debugger" data-component="webhook-debugger" aria-labelledby="b-title">
<h3 class="ds-block-title" id="b-title">example-title</h3>
<dl class="ds-facts">
<div>
<dt>Event schema</dt>
<dd>
<code>example-event_schema_ref</code>
</dd>
</div>
<div>
<dt>Events</dt>
<dd>Synthetic only</dd>
</div>
<div>
<dt>Events kept</dt>
<dd>1</dd>
</div>
<div>
<dt>Runs</dt>
<dd>
<code>example-operation</code> in the test environment</dd>
</div>
</dl>
<p class="ds-live-note" role="note">Simulating and inspecting webhook events needs the live documentation site.</p>
</section>
```

Preview (interface-only; the markup above is the same output):

The renderer resolves this component as a native block; the preview above is its real HTML output, and Markdown parity for native blocks is covered by the renderer test suite.

## Specification

Generated from `packages/contracts/component-specs/webhook-debugger.md`.

### Contract

Production props are normative in `../contracts/component-props/webhook-debugger.schema.json`. The corresponding `component-fixtures` manifest is only a minimal protocol fixture; use the production props schema when building the published package. The packaged artifact ships exactly its generated `component-package.json` manifest plus `props.schema.json` (the production props schema, copied byte-for-byte) and `spec.md` (this spec, copied byte-for-byte); it contains no executable payload, fallback implementation, Storybook, test suite, SSR harness or README. Rendering behavior and the acceptance cases below belong to the renderer and the repository tests, not to the package. Installation pins the package version and the digest of every shipped byte.

### Intended behavior

Construct synthetic envelope and show timing/signature validation through approved test endpoint.

### Failure and fallback

External destination requires scoped allowlist/confirmation; no arbitrary webhook relay.

### Required acceptance cases

Timestamp/retry/idempotency examples correct; actual signing secret never exposed. Also test empty data, loading, denied access, browser without JS, mobile 360px, keyboard navigation, dark mode and an explicit constrained agent tool call. The server independently authorizes capability requests; a package manifest cannot grant authority.

### Data and maintenance

Data bindings resolve from a specific publication/release vector and permitted fact/evidence graph. Configuration edits create versioned component patches. Update invalidation uses dependency IDs, never indiscriminate whole-page regeneration. Human-owned props survive automatic updates unless invalidated with an explicit conflict. Missing optional resources leave an honest inert/readable fallback, not a broken page or fake success.

### Cost and tools

Pure/local interaction must never invoke a model by accident. Any model, remote query or executor call must reserve approved budget before dispatch. Public visitors do not inherit owner resources. The component may call only named tools in its signed manifest with valid typed inputs. A cancelled job stops polling and closes resources. No component gets platform administration, raw credentials or an unlimited execution loop.

## Package manifest

Protocol fixture: `packages/contracts/component-fixtures/webhook-debugger.json`.

| Field | Value |
| --- | --- |
| Name | @docsloth/webhook-debugger |
| Version | 1.0.0 |
| Protocol | 1.x |
| License | Apache-2.0 |
| Runtime | react |
| Entry | dist/index.js |
| Recording policy | blocked |
| Fallback | html, markdown, json |
| Network hosts | none |
| Production write | no |
| Max runtime seconds | 120 |
| Integrity | all zeros (protocol fixture placeholder) |

| Tool | Effect | Confirmation | Input |
| --- | --- | --- | --- |
| simulate | execute | no | value |
| inspect | read | no | value |

## Sources

| Source | Path |
| --- | --- |
| Component page | https://registry.docsloth.dev/components/webhook-debugger.html |
| Markdown twin | https://registry.docsloth.dev/docs/webhook-debugger.md |
| LLM index | https://registry.docsloth.dev/llms.txt |
| Specification | packages/contracts/component-specs/webhook-debugger.md |
| Prop schema | packages/contracts/component-props/webhook-debugger.schema.json |
| Protocol fixture | packages/contracts/component-fixtures/webhook-debugger.json |
| Catalog | packages/contracts/component-catalog.json |


---

# event-stream

Inspect an authorized event stream

| Field | Value |
| --- | --- |
| Trust class | connected |
| Implementation status | implemented_native |
| Renderer | native block |
| Key prop (production schema) | resource |
| Key prop (protocol fixture) | streamId |
| Tools | subscribe, pause |
| Package version | 1.0.0 |
| Package digest | sha256:562d76e0327281cf0148e93323ff4ccbdcb4bfd48fcee7fe363c359c888fa77e |

## Install

```sh
docsloth component add @docsloth/event-stream@1.0.0
```

Live package: sha256:562d76e0327281cf0148e93323ff4ccbdcb4bfd48fcee7fe363c359c888fa77e with 2 file digest(s); the catalog entry is generated from the built package, not a placeholder.

## Props

The prop schema is normative in `packages/contracts/component-props/event-stream.schema.json`.

| Prop | Type | Required | Constraints |
| --- | --- | --- | --- |
| `title` | string | no | maxLength: 160 |
| `resource` | object | yes | additionalProperties: false |
| `resource.resource_id` | string | yes | format: uuid |
| `resource.operation` | string | yes | maxLength: 160 |
| `resource.environment` | "test" \| "staging" \| "production" | yes |  |
| `schema_ref` | string | yes | maxLength: 256 |
| `max_buffer_events` | integer | yes |  |
| `redacted_fields` | array<string> | yes |  |

Example props generated from this schema:

```json
{
  "title": "example-title",
  "resource": {
    "resource_id": "00000000-0000-4000-8000-000000000000",
    "operation": "example-operation",
    "environment": "test"
  },
  "schema_ref": "example-schema_ref",
  "max_buffer_events": 1,
  "redacted_fields": [
    "example-redacted_fields"
  ]
}
```

Required props: resource, schema_ref, max_buffer_events, redacted_fields.

## Example

Example document IR (the block the renderer consumes):

```json
{
  "type": "event-stream",
  "props": {
    "title": "example-title",
    "resource": {
      "resource_id": "00000000-0000-4000-8000-000000000000",
      "operation": "example-operation",
      "environment": "test"
    },
    "schema_ref": "example-schema_ref",
    "max_buffer_events": 1,
    "redacted_fields": [
      "example-redacted_fields"
    ]
  }
}
```

Renderer HTML (entities decoded and wrapped for display):

```html
<section class="ds-block ds-event-stream" data-component="event-stream" aria-labelledby="b-title">
<h3 class="ds-block-title" id="b-title">example-title</h3>
<dl class="ds-facts">
<div>
<dt>Event schema</dt>
<dd>
<code>example-schema_ref</code>
</dd>
</div>
<div>
<dt>Events buffered</dt>
<dd>1</dd>
</div>
<div>
<dt>Redacted fields</dt>
<dd>
<code>example-redacted_fields</code>
</dd>
</div>
<div>
<dt>Runs</dt>
<dd>
<code>example-operation</code> in the test environment</dd>
</div>
</dl>
<p class="ds-live-note" role="note">Subscribing to this event stream needs the live documentation site.</p>
</section>
```

Preview (interface-only; the markup above is the same output):

The renderer resolves this component as a native block; the preview above is its real HTML output, and Markdown parity for native blocks is covered by the renderer test suite.

## Specification

Generated from `packages/contracts/component-specs/event-stream.md`.

### Contract

Production props are normative in `../contracts/component-props/event-stream.schema.json`. The corresponding `component-fixtures` manifest is only a minimal protocol fixture; use the production props schema when building the published package. The packaged artifact ships exactly its generated `component-package.json` manifest plus `props.schema.json` (the production props schema, copied byte-for-byte) and `spec.md` (this spec, copied byte-for-byte); it contains no executable payload, fallback implementation, Storybook, test suite, SSR harness or README. Rendering behavior and the acceptance cases below belong to the renderer and the repository tests, not to the package. Installation pins the package version and the digest of every shipped byte.

### Intended behavior

Bounded stream with disconnect, pause and dropped-events indicator.

### Failure and fallback

Backpressure drops oldest display events with count, not unlimited RAM.

### Required acceptance cases

Authorization revocation closes stream promptly. Also test empty data, loading, denied access, browser without JS, mobile 360px, keyboard navigation, dark mode and an explicit constrained agent tool call. The server independently authorizes capability requests; a package manifest cannot grant authority.

### Data and maintenance

Data bindings resolve from a specific publication/release vector and permitted fact/evidence graph. Configuration edits create versioned component patches. Update invalidation uses dependency IDs, never indiscriminate whole-page regeneration. Human-owned props survive automatic updates unless invalidated with an explicit conflict. Missing optional resources leave an honest inert/readable fallback, not a broken page or fake success.

### Cost and tools

Pure/local interaction must never invoke a model by accident. Any model, remote query or executor call must reserve approved budget before dispatch. Public visitors do not inherit owner resources. The component may call only named tools in its signed manifest with valid typed inputs. A cancelled job stops polling and closes resources. No component gets platform administration, raw credentials or an unlimited execution loop.

### React host integration

Production resource/operation/environment, schema reference, 1–500 buffered events and redacted field paths select `ComponentContentProvider.eventStreams` through `eventStreamKey`. At most 64 unique dotted paths (256 characters and 8 segments each) are accepted; numeric segments address array entries. Available records bind the exact release, resource, schema reference/version, reader session, buffer count and sorted redaction paths.

Connecting is explicit. The typed host `subscribe` adapter receives that scope, an AbortSignal and `onFrame`, then returns a matching connected result with a close callback. Each event or terminal frame repeats the exact scope. Event frames must attest `redaction: applied` and `schemaValidation: passed`; the host must actually enforce audience permissions and the referenced versioned schema before delivery. These flags are host claims, not independent client schema validation. Transport buffering, authorization checks throughout a subscription, credential handling, remote query budgets and prompt revocation remain host responsibilities. No generic executor or model call is issued by the component.

The renderer admits zoned valid timestamps and detached JSON payloads only. Each payload is bounded to depth 8, 1000 visited nodes, 64 keys per object, 128 array entries and 4096 UTF-16 units per string; the complete retained event must fit 16 KiB of UTF-8 JSON. Configured paths are replaced before retention, and common credential/email/IP patterns receive display masking. This is defense in depth, not a guarantee of complete PII detection: private data must never be sent to the browser in the first place. Unknown frame/event metadata is discarded.

A live buffer drops the oldest events beyond the configured count or 128 KiB of serialized UTF-8 events, with a dropped count. Duplicate IDs still in the buffer are ignored. Display updates run at most every 100 ms instead of queuing React work for every incoming event. Pause freezes the displayed event snapshot; the connection continues, the live buffer remains bounded, and the drop count continues to update. The paused display can retain a second bounded snapshot. Resume shows the latest retained events. Disconnect closes the local connection and preserves last received content. A fresh connection clears prior history; there is no automatic reconnect or claim that unobserved events were recovered.

Permission revocation clears both displayed and buffered events and aborts/closes the subscription, including while paused. Invalid frames, changed scope, unmount and late connection acknowledgements also clean up old resources. Cleanup errors cannot produce unhandled rejections; the host must honor the signal and close callback to stop remote work. Missing/restricted/loading/denied/unsupported/ rate-limited/ended/error states are explicit. No-JavaScript rendering is readable with connection controls disabled. Actual production stream transport and core/cloud resource integration remain separate work.

## Package manifest

Protocol fixture: `packages/contracts/component-fixtures/event-stream.json`.

| Field | Value |
| --- | --- |
| Name | @docsloth/event-stream |
| Version | 1.0.0 |
| Protocol | 1.x |
| License | Apache-2.0 |
| Runtime | react |
| Entry | dist/index.js |
| Recording policy | blocked |
| Fallback | html, markdown, json |
| Network hosts | none |
| Production write | no |
| Max runtime seconds | 120 |
| Integrity | all zeros (protocol fixture placeholder) |

| Tool | Effect | Confirmation | Input |
| --- | --- | --- | --- |
| subscribe | read | no | value |
| pause | read | no | value |

## Sources

| Source | Path |
| --- | --- |
| Component page | https://registry.docsloth.dev/components/event-stream.html |
| Markdown twin | https://registry.docsloth.dev/docs/event-stream.md |
| LLM index | https://registry.docsloth.dev/llms.txt |
| Specification | packages/contracts/component-specs/event-stream.md |
| Prop schema | packages/contracts/component-props/event-stream.schema.json |
| Protocol fixture | packages/contracts/component-fixtures/event-stream.json |
| Catalog | packages/contracts/component-catalog.json |


---

# logs

View redacted approved diagnostic logs

| Field | Value |
| --- | --- |
| Trust class | connected |
| Implementation status | implemented_native |
| Renderer | native block |
| Key prop (production schema) | resource |
| Key prop (protocol fixture) | query |
| Tools | query, filter |
| Package version | 1.0.0 |
| Package digest | sha256:ab7d4448c13820a9f6a9a6d8fa00cd07a37884dd142754f531cb34fbd78fb9c7 |

## Install

```sh
docsloth component add @docsloth/logs@1.0.0
```

Live package: sha256:ab7d4448c13820a9f6a9a6d8fa00cd07a37884dd142754f531cb34fbd78fb9c7 with 2 file digest(s); the catalog entry is generated from the built package, not a placeholder.

## Props

The prop schema is normative in `packages/contracts/component-props/logs.schema.json`.

| Prop | Type | Required | Constraints |
| --- | --- | --- | --- |
| `title` | string | no | maxLength: 160 |
| `resource` | object | yes | additionalProperties: false |
| `resource.resource_id` | string | yes | format: uuid |
| `resource.operation` | string | yes | maxLength: 160 |
| `resource.environment` | "test" \| "staging" \| "production" | yes |  |
| `query_template_id` | string | yes | maxLength: 256 |
| `max_rows` | integer | yes |  |
| `redaction_profile` | string | yes | maxLength: 256 |

Example props generated from this schema:

```json
{
  "title": "example-title",
  "resource": {
    "resource_id": "00000000-0000-4000-8000-000000000000",
    "operation": "example-operation",
    "environment": "test"
  },
  "query_template_id": "example-query_template_id",
  "max_rows": 1,
  "redaction_profile": "example-redaction_profile"
}
```

Required props: resource, query_template_id, max_rows, redaction_profile.

## Example

Example document IR (the block the renderer consumes):

```json
{
  "type": "logs",
  "props": {
    "title": "example-title",
    "resource": {
      "resource_id": "00000000-0000-4000-8000-000000000000",
      "operation": "example-operation",
      "environment": "test"
    },
    "query_template_id": "example-query_template_id",
    "max_rows": 1,
    "redaction_profile": "example-redaction_profile"
  }
}
```

Renderer HTML (entities decoded and wrapped for display):

```html
<section class="ds-block ds-logs" data-component="logs" aria-labelledby="b-title">
<h3 class="ds-block-title" id="b-title">example-title</h3>
<dl class="ds-facts">
<div>
<dt>Query</dt>
<dd>
<code>example-query_template_id</code>
</dd>
</div>
<div>
<dt>Row limit</dt>
<dd>1</dd>
</div>
<div>
<dt>Redaction profile</dt>
<dd>
<code>example-redaction_profile</code>
</dd>
</div>
<div>
<dt>Runs</dt>
<dd>
<code>example-operation</code> in the test environment</dd>
</div>
</dl>
<p class="ds-live-note" role="note">Querying logs needs the live documentation site.</p>
</section>
```

Preview (interface-only; the markup above is the same output):

The renderer resolves this component as a native block; the preview above is its real HTML output, and Markdown parity for native blocks is covered by the renderer test suite.

## Specification

Generated from `packages/contracts/component-specs/logs.md`.

### Contract

Production props are normative in `../contracts/component-props/logs.schema.json`. The corresponding `component-fixtures` manifest is only a minimal protocol fixture; use the production props schema when building the published package. The packaged artifact ships exactly its generated `component-package.json` manifest plus `props.schema.json` (the production props schema, copied byte-for-byte) and `spec.md` (this spec, copied byte-for-byte); it contains no executable payload, fallback implementation, Storybook, test suite, SSR harness or README. Rendering behavior and the acceptance cases below belong to the renderer and the repository tests, not to the package. Installation pins the package version and the digest of every shipped byte.

### Intended behavior

Approved parameterized log queries only; no general SQL or unrestricted production log access.

### Failure and fallback

Timeout exposes redacted error; log lines treated as untrusted text.

The React component resolves `ComponentContentProvider.logQueries` using `logQueryKey(resource, query_template_id, redaction_profile, max_rows)`. An available adapter is pinned to the release, actor session, query version and all key fields. It may supply a redacted snapshot and an explicit query action; no query runs during rendering, hydration or local level filtering. General SQL, arbitrary query strings and legacy inline `lines` props are not accepted.

The host authorizes and budgets each query, enforces the approved template and row limit, and applies its redaction profile before sending data to the client. Snapshots must identify the complete scope, capture time, immutable snapshot ID, truncation and applied redaction. The client admits at most the requested 1–500 rows, 4,096 UTF-16 code units per message and 131,072 total code units of row identifiers/messages. Identifiers are bounded and unique, severity is typed, and timestamp dates/times must be valid and explicitly zoned. Extra response fields are discarded. Host serialization and transport need independent byte limits; these in-memory checks do not bound an untrusted network response.

Common credential, email and IP patterns are additionally masked for display, and markup is rendered as text. This is not complete PII detection and cannot protect data already delivered. Failed queries show a fixed public-safe error, never raw server details. Denial or malformed results clear prior rows. Stop waiting aborts the adapter signal and discards late replies, without claiming server cancellation. Scope and supplied snapshot changes reset displayed data. No browser persistence, polling, model or executor dispatch occurs. Production core/cloud transport and server protections remain host integration work.

### Required acceptance cases

Stored XSS and PII token fixtures never rendered raw. Also test empty data, loading, denied access, browser without JS, mobile 360px, keyboard navigation, dark mode and an explicit constrained agent tool call. The server independently authorizes capability requests; a package manifest cannot grant authority.

### Data and maintenance

Data bindings resolve from a specific publication/release vector and permitted fact/evidence graph. Configuration edits create versioned component patches. Update invalidation uses dependency IDs, never indiscriminate whole-page regeneration. Human-owned props survive automatic updates unless invalidated with an explicit conflict. Missing optional resources leave an honest inert/readable fallback, not a broken page or fake success.

### Cost and tools

Pure/local interaction must never invoke a model by accident. Any model, remote query or executor call must reserve approved budget before dispatch. Public visitors do not inherit owner resources. The component may call only named tools in its signed manifest with valid typed inputs. A cancelled job stops polling and closes resources. No component gets platform administration, raw credentials or an unlimited execution loop.

## Package manifest

Protocol fixture: `packages/contracts/component-fixtures/logs.json`.

| Field | Value |
| --- | --- |
| Name | @docsloth/logs |
| Version | 1.0.0 |
| Protocol | 1.x |
| License | Apache-2.0 |
| Runtime | react |
| Entry | dist/index.js |
| Recording policy | blocked |
| Fallback | html, markdown, json |
| Network hosts | none |
| Production write | no |
| Max runtime seconds | 120 |
| Integrity | all zeros (protocol fixture placeholder) |

| Tool | Effect | Confirmation | Input |
| --- | --- | --- | --- |
| query | read | no | value |
| filter | read | no | value |

## Sources

| Source | Path |
| --- | --- |
| Component page | https://registry.docsloth.dev/components/logs.html |
| Markdown twin | https://registry.docsloth.dev/docs/logs.md |
| LLM index | https://registry.docsloth.dev/llms.txt |
| Specification | packages/contracts/component-specs/logs.md |
| Prop schema | packages/contracts/component-props/logs.schema.json |
| Protocol fixture | packages/contracts/component-fixtures/logs.json |
| Catalog | packages/contracts/component-catalog.json |


---

# status

Read-only authorized deployment status

| Field | Value |
| --- | --- |
| Trust class | connected |
| Implementation status | implemented_native |
| Renderer | native block |
| Key prop (production schema) | resource |
| Key prop (protocol fixture) | serviceId |
| Tools | refresh |
| Package version | 1.0.0 |
| Package digest | sha256:595525426f7f977b02bf449134768f228d474d11b24e99f41e0c408d0f8ad34d |

## Install

```sh
docsloth component add @docsloth/status@1.0.0
```

Live package: sha256:595525426f7f977b02bf449134768f228d474d11b24e99f41e0c408d0f8ad34d with 2 file digest(s); the catalog entry is generated from the built package, not a placeholder.

## Props

The prop schema is normative in `packages/contracts/component-props/status.schema.json`.

| Prop | Type | Required | Constraints |
| --- | --- | --- | --- |
| `title` | string | no | maxLength: 160 |
| `resource` | object | yes | additionalProperties: false |
| `resource.resource_id` | string | yes | format: uuid |
| `resource.operation` | string | yes | maxLength: 160 |
| `resource.environment` | "test" \| "staging" \| "production" | yes |  |
| `service_ids` | array<string> | yes |  |
| `refresh_seconds` | integer | yes |  |

Example props generated from this schema:

```json
{
  "title": "example-title",
  "resource": {
    "resource_id": "00000000-0000-4000-8000-000000000000",
    "operation": "example-operation",
    "environment": "test"
  },
  "service_ids": [
    "example-service_ids"
  ],
  "refresh_seconds": 30
}
```

Required props: resource, service_ids, refresh_seconds.

## Example

Example document IR (the block the renderer consumes):

```json
{
  "type": "status",
  "props": {
    "title": "example-title",
    "resource": {
      "resource_id": "00000000-0000-4000-8000-000000000000",
      "operation": "example-operation",
      "environment": "test"
    },
    "service_ids": [
      "example-service_ids"
    ],
    "refresh_seconds": 30
  }
}
```

Renderer HTML (entities decoded and wrapped for display):

```html
<section class="ds-block ds-status" data-component="status" aria-labelledby="b-title">
<h3 class="ds-block-title" id="b-title">example-title</h3>
<dl class="ds-facts">
<div>
<dt>Services</dt>
<dd>
<code>example-service_ids</code>
</dd>
</div>
<div>
<dt>Refresh interval</dt>
<dd>30 s</dd>
</div>
<div>
<dt>Runs</dt>
<dd>
<code>example-operation</code> in the test environment</dd>
</div>
</dl>
<p class="ds-live-note" role="note">Current status is not part of this page; check the live documentation site.</p>
</section>
```

Preview (interface-only; the markup above is the same output):

The renderer resolves this component as a native block; the preview above is its real HTML output, and Markdown parity for native blocks is covered by the renderer test suite.

## Specification

Generated from `packages/contracts/component-specs/status.md`.

### Contract

Production props are normative in `../contracts/component-props/status.schema.json`. The corresponding `component-fixtures` manifest is only a minimal protocol fixture; use the production props schema when building the published package. The packaged artifact ships exactly its generated `component-package.json` manifest plus `props.schema.json` (the production props schema, copied byte-for-byte) and `spec.md` (this spec, copied byte-for-byte); it contains no executable payload, fallback implementation, Storybook, test suite, SSR harness or README. Rendering behavior and the acceptance cases below belong to the renderer and the repository tests, not to the package. Installation pins the package version and the digest of every shipped byte.

### Intended behavior

Read status timestamp and coverage; no claim software healthy merely docs host up.

### Failure and fallback

Last known value marked stale after two refresh intervals.

The React host supplies `ComponentContentProvider.statusQueries` keyed by `statusQueryKey(resource, service_ids, refresh_seconds)`. Keys sort the selected service IDs; display order follows the production props. The binding and result match release, actor session, resource operation/environment, selected services, refresh interval and query version. Up to 100 unique bounded service IDs are accepted. Snapshots carry explicit coverage, capture time and bounded individual service observations (`operational`, `degraded`, `outage`, `unknown`) with their own check timestamps. Missing services remain uncovered/unknown; complete coverage cannot omit services. Extra or duplicate services refuse. Text is escaped, bounded to 65,536 aggregate code units, and arbitrary fields discarded.

No-JavaScript output labels values as last reported and freshness unchecked. After hydration a local clock marks each observation stale at exactly twice `refresh_seconds`, measured from that observation's check time. A timestamp ahead of the client clock is unverified. The clock does not poll the network. Refresh is an explicit manual action; scheduled refresh, if desired, belongs to an authorized host with its own per-call budget and cancellation policy.

Only a typed matching snapshot can confirm a refresh. A successful HTTP response, executor stdout or a reachable documentation host cannot establish software health. Failed, unsupported, rate-limited and cancelled refreshes preserve last-known values as unverified until a valid result, including during retries. Denial clears them. Scope or supplied snapshot changes reset the view; late replies after cancellation or replacement are ignored. The host must authorize before delivery and independently observe service health. The component does not implement production transport, health probes, model calls or persistence.

### Required acceptance cases

Network failure never renders green success. Also test empty data, loading, denied access, browser without JS, mobile 360px, keyboard navigation, dark mode and an explicit constrained agent tool call. The server independently authorizes capability requests; a package manifest cannot grant authority.

### Data and maintenance

Data bindings resolve from a specific publication/release vector and permitted fact/evidence graph. Configuration edits create versioned component patches. Update invalidation uses dependency IDs, never indiscriminate whole-page regeneration. Human-owned props survive automatic updates unless invalidated with an explicit conflict. Missing optional resources leave an honest inert/readable fallback, not a broken page or fake success.

### Cost and tools

Pure/local interaction must never invoke a model by accident. Any model, remote query or executor call must reserve approved budget before dispatch. Public visitors do not inherit owner resources. The component may call only named tools in its signed manifest with valid typed inputs. A cancelled job stops polling and closes resources. No component gets platform administration, raw credentials or an unlimited execution loop.

## Package manifest

Protocol fixture: `packages/contracts/component-fixtures/status.json`.

| Field | Value |
| --- | --- |
| Name | @docsloth/status |
| Version | 1.0.0 |
| Protocol | 1.x |
| License | Apache-2.0 |
| Runtime | react |
| Entry | dist/index.js |
| Recording policy | blocked |
| Fallback | html, markdown, json |
| Network hosts | none |
| Production write | no |
| Max runtime seconds | 120 |
| Integrity | all zeros (protocol fixture placeholder) |

| Tool | Effect | Confirmation | Input |
| --- | --- | --- | --- |
| refresh | read | no | value |

## Sources

| Source | Path |
| --- | --- |
| Component page | https://registry.docsloth.dev/components/status.html |
| Markdown twin | https://registry.docsloth.dev/docs/status.md |
| LLM index | https://registry.docsloth.dev/llms.txt |
| Specification | packages/contracts/component-specs/status.md |
| Prop schema | packages/contracts/component-props/status.schema.json |
| Protocol fixture | packages/contracts/component-fixtures/status.json |
| Catalog | packages/contracts/component-catalog.json |


---

# feedback

Submit bounded document feedback

| Field | Value |
| --- | --- |
| Trust class | connected |
| Implementation status | implemented_native |
| Renderer | native block |
| Key prop (production schema) | page_id |
| Key prop (protocol fixture) | pageId |
| Tools | submit |
| Package version | 1.0.0 |
| Package digest | sha256:ea984d36a3eb7427a33d3fc3c31ca3ee5389ca9973a7b21c42ef5bb740ead3c5 |

## Install

```sh
docsloth component add @docsloth/feedback@1.0.0
```

Live package: sha256:ea984d36a3eb7427a33d3fc3c31ca3ee5389ca9973a7b21c42ef5bb740ead3c5 with 2 file digest(s); the catalog entry is generated from the built package, not a placeholder.

## Props

The prop schema is normative in `packages/contracts/component-props/feedback.schema.json`.

| Prop | Type | Required | Constraints |
| --- | --- | --- | --- |
| `title` | string | no | maxLength: 160 |
| `page_id` | string | yes | format: uuid |
| `publication_id` | string | yes | format: uuid |
| `prompt` | string | yes |  |
| `allow_comment` | boolean | yes |  |

Example props generated from this schema:

```json
{
  "title": "example-title",
  "page_id": "00000000-0000-4000-8000-000000000000",
  "publication_id": "00000000-0000-4000-8000-000000000000",
  "prompt": "example-prompt",
  "allow_comment": true
}
```

Required props: page_id, publication_id, prompt, allow_comment.

## Example

Example document IR (the block the renderer consumes):

```json
{
  "type": "feedback",
  "props": {
    "title": "example-title",
    "page_id": "00000000-0000-4000-8000-000000000000",
    "publication_id": "00000000-0000-4000-8000-000000000000",
    "prompt": "example-prompt",
    "allow_comment": true
  }
}
```

Renderer HTML (entities decoded and wrapped for display):

```html
<section class="ds-block ds-feedback" data-component="feedback" aria-labelledby="b-title">
<h3 class="ds-block-title" id="b-title">example-title</h3>
<p>example-prompt</p>
<dl class="ds-facts">
<div>
<dt>Comments</dt>
<dd>Welcome</dd>
</div>
</dl>
<p class="ds-live-note" role="note">Sending feedback needs the live documentation site.</p>
</section>
```

Preview (interface-only; the markup above is the same output):

The renderer resolves this component as a native block; the preview above is its real HTML output, and Markdown parity for native blocks is covered by the renderer test suite.

## Specification

Generated from `packages/contracts/component-specs/feedback.md`.

### Contract

Production props are normative in `../contracts/component-props/feedback.schema.json`. The corresponding `component-fixtures` manifest is only a minimal protocol fixture; use the production props schema when building the published package. The packaged artifact ships exactly its generated `component-package.json` manifest plus `props.schema.json` (the production props schema, copied byte-for-byte) and `spec.md` (this spec, copied byte-for-byte); it contains no executable payload, fallback implementation, Storybook, test suite, SSR harness or README. Rendering behavior and the acceptance cases below belong to the renderer and the repository tests, not to the package. Installation pins the package version and the digest of every shipped byte.

### Intended behavior

Useful yes/no and bounded feedback with disclosure of processing, not identity requirement by default.

### Failure and fallback

Retry preserves idempotency; abusive input safely stored/redacted.

The React implementation resolves `ComponentContentProvider.feedback` through `feedbackKey(publication_id, page_id)`. Available records supply a matching release, publication, page, form version, actor session, processing disclosure and typed submit adapter. Anonymous sessions are allowed. The host authorizes each call, enforces page/publication membership and input/rate limits, redacts or moderates text before storage, and durably deduplicates the scoped idempotency key. These server protections are not supplied by client rendering.

The form retains an unchanged payload's random idempotency key across retries within its mounted scope. Changing the submitted payload creates a new key; scope changes and explicit new-feedback actions reset the draft. A reload does not preserve browser-local drafts or retry keys. Acceptance requires a typed receipt matching the complete scope and key, never a generic HTTP success or executor stdout. Cancellation stops waiting and ignores late replies without claiming that remote storage was rolled back. The optional comment is limited to 2,000 UTF-16 code units. The host must enforce the same or tighter bound.

Without JavaScript the prompt and disclosure remain readable and controls are disabled. Missing, restricted and loading adapters are explicit. No model, executor, browser persistence or billing dispatch is performed by this form. Actual production transport and backend integration remain host responsibilities.

### Required acceptance cases

No feedback event converted directly to billable financial event. Also test empty data, loading, denied access, browser without JS, mobile 360px, keyboard navigation, dark mode and an explicit constrained agent tool call. The server independently authorizes capability requests; a package manifest cannot grant authority.

### Data and maintenance

Data bindings resolve from a specific publication/release vector and permitted fact/evidence graph. Configuration edits create versioned component patches. Update invalidation uses dependency IDs, never indiscriminate whole-page regeneration. Human-owned props survive automatic updates unless invalidated with an explicit conflict. Missing optional resources leave an honest inert/readable fallback, not a broken page or fake success.

### Cost and tools

Pure/local interaction must never invoke a model by accident. Any model, remote query or executor call must reserve approved budget before dispatch. Public visitors do not inherit owner resources. The component may call only named tools in its signed manifest with valid typed inputs. A cancelled job stops polling and closes resources. No component gets platform administration, raw credentials or an unlimited execution loop.

## Package manifest

Protocol fixture: `packages/contracts/component-fixtures/feedback.json`.

| Field | Value |
| --- | --- |
| Name | @docsloth/feedback |
| Version | 1.0.0 |
| Protocol | 1.x |
| License | Apache-2.0 |
| Runtime | react |
| Entry | dist/index.js |
| Recording policy | blocked |
| Fallback | html, markdown, json |
| Network hosts | none |
| Production write | no |
| Max runtime seconds | 120 |
| Integrity | all zeros (protocol fixture placeholder) |

| Tool | Effect | Confirmation | Input |
| --- | --- | --- | --- |
| submit | external_write | no | value |

## Sources

| Source | Path |
| --- | --- |
| Component page | https://registry.docsloth.dev/components/feedback.html |
| Markdown twin | https://registry.docsloth.dev/docs/feedback.md |
| LLM index | https://registry.docsloth.dev/llms.txt |
| Specification | packages/contracts/component-specs/feedback.md |
| Prop schema | packages/contracts/component-props/feedback.schema.json |
| Protocol fixture | packages/contracts/component-fixtures/feedback.json |
| Catalog | packages/contracts/component-catalog.json |


---

# checklist

Track local tutorial progress

| Field | Value |
| --- | --- |
| Trust class | interactive |
| Implementation status | implemented_native |
| Renderer | native block |
| Key prop (production schema) | items |
| Key prop (protocol fixture) | items |
| Tools | toggle, reset |
| Package version | 1.0.0 |
| Package digest | sha256:90d811d2436bb54d136a8e00969f1240fec4a4141478b9d997010bc4b6fcc226 |

## Install

```sh
docsloth component add @docsloth/checklist@1.0.0
```

Live package: sha256:90d811d2436bb54d136a8e00969f1240fec4a4141478b9d997010bc4b6fcc226 with 2 file digest(s); the catalog entry is generated from the built package, not a placeholder.

## Props

The prop schema is normative in `packages/contracts/component-props/checklist.schema.json`.

| Prop | Type | Required | Constraints |
| --- | --- | --- | --- |
| `title` | string | no | maxLength: 160 |
| `items` | array<object> | yes |  |
| `persist_locally` | boolean | yes |  |

Example props generated from this schema:

```json
{
  "title": "example-title",
  "items": [
    {
      "id": "example-id",
      "label": "example-label",
      "required": true
    }
  ],
  "persist_locally": true
}
```

Required props: items, persist_locally.

## Example

Example document IR (the block the renderer consumes):

```json
{
  "type": "checklist",
  "props": {
    "title": "example-title",
    "items": [
      {
        "id": "example-id",
        "label": "example-label",
        "required": true
      }
    ],
    "persist_locally": true
  }
}
```

Renderer HTML (entities decoded and wrapped for display):

```html
<section class="ds-block ds-checklist" data-component="checklist" aria-labelledby="b-title">
<h3 class="ds-block-title" id="b-title">example-title</h3>
<ul class="ds-checklist">
<li>
<span class="ds-check" aria-hidden="true" data-markdown-ignore="true">☐</span> example-label (required)</li>
</ul>
<p class="ds-live-note" role="note">Checking items off and saving progress needs the live documentation site.</p>
</section>
```

Preview (interface-only; the markup above is the same output):

The renderer resolves this component as a native block; the preview above is its real HTML output, and Markdown parity for native blocks is covered by the renderer test suite.

## Specification

Generated from `packages/contracts/component-specs/checklist.md`.

### Contract

Production props are normative in `../contracts/component-props/checklist.schema.json`. The corresponding `component-fixtures` manifest is only a minimal protocol fixture; use the production props schema when building the published package. The packaged artifact ships exactly its generated `component-package.json` manifest plus `props.schema.json` (the production props schema, copied byte-for-byte) and `spec.md` (this spec, copied byte-for-byte); it contains no executable payload, fallback implementation, Storybook, test suite, SSR harness or README. Rendering behavior and the acceptance cases below belong to the renderer and the repository tests, not to the package. Installation pins the package version and the digest of every shipped byte.

### Intended behavior

The official React component renders every item as a labelled checkbox after hydration, marks required instructions, counts local completion and provides Reset progress. Completion is explicitly self-reported and never machine verification. Before hydration or without JavaScript, all instructions remain readable without inert controls or a misleading live progress counter. The native IR renderer remains a static task list.

### Failure and fallback

`persist_locally: true` saves checkmarks in browser localStorage only when the host supplies a nonempty releaseId through ComponentContentProvider. The key contains the release, title, ordered item IDs/labels/required flags and persistence setting; changed content or release starts separate progress. Identical checklists in the same release share saved progress on reload. No global cross-page or cross-release key is used, and checkmarks never authorize execution. Hosts must use a release identity that changes with publication versions.

Absent publication context, disabled persistence, corrupt data or denied/full storage falls back to memory with a visible notice. Reset clears this checklist's checkmarks. Old version keys are not automatically deleted; browser storage limits can trigger the memory fallback. Empty lists and malformed or duplicate item IDs have explicit messages. No network or model calls occur.

### Required acceptance cases

Reset and page version invalidation. Also test empty data, loading, denied access, browser without JS, mobile 360px, keyboard navigation, dark mode and an explicit constrained agent tool call. The server independently authorizes capability requests; a package manifest cannot grant authority.

### Data and maintenance

Data bindings resolve from a specific publication/release vector and permitted fact/evidence graph. Configuration edits create versioned component patches. Update invalidation uses dependency IDs, never indiscriminate whole-page regeneration. Human-owned props survive automatic updates unless invalidated with an explicit conflict. Missing optional resources leave an honest inert/readable fallback, not a broken page or fake success.

### Cost and tools

Pure/local interaction must never invoke a model by accident. Any model, remote query or executor call must reserve approved budget before dispatch. Public visitors do not inherit owner resources. The component may call only named tools in its signed manifest with valid typed inputs. A cancelled job stops polling and closes resources. No component gets platform administration, raw credentials or an unlimited execution loop.

## Package manifest

Protocol fixture: `packages/contracts/component-fixtures/checklist.json`.

| Field | Value |
| --- | --- |
| Name | @docsloth/checklist |
| Version | 1.0.0 |
| Protocol | 1.x |
| License | Apache-2.0 |
| Runtime | react |
| Entry | dist/index.js |
| Recording policy | masked |
| Fallback | html, markdown, json |
| Network hosts | none |
| Production write | no |
| Max runtime seconds | 0 |
| Integrity | all zeros (protocol fixture placeholder) |

| Tool | Effect | Confirmation | Input |
| --- | --- | --- | --- |
| toggle | local_write | no | value |
| reset | local_write | no | value |

## Sources

| Source | Path |
| --- | --- |
| Component page | https://registry.docsloth.dev/components/checklist.html |
| Markdown twin | https://registry.docsloth.dev/docs/checklist.md |
| LLM index | https://registry.docsloth.dev/llms.txt |
| Specification | packages/contracts/component-specs/checklist.md |
| Prop schema | packages/contracts/component-props/checklist.schema.json |
| Protocol fixture | packages/contracts/component-fixtures/checklist.json |
| Catalog | packages/contracts/component-catalog.json |


---

# cards

Choose task-oriented navigation

| Field | Value |
| --- | --- |
| Trust class | pure |
| Implementation status | implemented_native |
| Renderer | native block |
| Key prop (production schema) | items |
| Key prop (protocol fixture) | items |
| Tools | none |
| Package version | 1.0.0 |
| Package digest | sha256:135257635d5f1c26b0a06458ab2d8b7ef24e4a9ff9a407aa29860dcc19eceb67 |

## Install

```sh
docsloth component add @docsloth/cards@1.0.0
```

Live package: sha256:135257635d5f1c26b0a06458ab2d8b7ef24e4a9ff9a407aa29860dcc19eceb67 with 2 file digest(s); the catalog entry is generated from the built package, not a placeholder.

## Props

The prop schema is normative in `packages/contracts/component-props/cards.schema.json`.

| Prop | Type | Required | Constraints |
| --- | --- | --- | --- |
| `title` | string | no | maxLength: 160 |
| `items` | array<object> | yes |  |
| `columns` | integer | yes |  |

Example props generated from this schema:

```json
{
  "title": "example-title",
  "items": [
    {
      "id": "example-id",
      "label": "example-label",
      "description": "example-description",
      "href": "example-href"
    }
  ],
  "columns": 1
}
```

Required props: items, columns.

## Example

Example document IR (the block the renderer consumes):

```json
{
  "type": "cards",
  "props": {
    "title": "Explore",
    "columns": 2
  },
  "children": [
    {
      "type": "prose",
      "props": {
        "label": "Guides",
        "href": "/guides",
        "text": "Task-oriented walkthroughs."
      }
    },
    {
      "type": "prose",
      "props": {
        "label": "Reference",
        "text": "Component reference."
      }
    }
  ]
}
```

Renderer HTML (entities decoded and wrapped for display):

```html
<section class="ds-cards" data-component="cards" aria-label="Explore" data-columns="2">
<article class="ds-card">
<h3 class="ds-card-title">
<a href="/guides">Guides</a>
</h3>
<div class="ds-prose">Task-oriented walkthroughs.</div>
</article>
<article class="ds-card">
<h3 class="ds-card-title">Reference</h3>
<div class="ds-prose">Component reference.</div>
</article>
</section>
```

Preview (interface-only; the markup above is the same output):

The renderer resolves this component as a native block; the preview above is its real HTML output, and Markdown parity for native blocks is covered by the renderer test suite.

## Specification

Generated from `packages/contracts/component-specs/cards.md`.

### Contract

Production props are normative in `../contracts/component-props/cards.schema.json`. The corresponding `component-fixtures` manifest is only a minimal protocol fixture; use the production props schema when building the published package. The packaged artifact ships exactly its generated `component-package.json` manifest plus `props.schema.json` (the production props schema, copied byte-for-byte) and `spec.md` (this spec, copied byte-for-byte); it contains no executable payload, fallback implementation, Storybook, test suite, SSR harness or README. Rendering behavior and the acceptance cases below belong to the renderer and the repository tests, not to the package. Installation pins the package version and the digest of every shipped byte.

### Intended behavior

Task cards with descriptive links; mobile single column.

### Failure and fallback

Bad URL rejected by URL policy.

### Required acceptance cases

Whole card keyboard focus without duplicate interactive nesting. Also test empty data, loading, denied access, browser without JS, mobile 360px, keyboard navigation, dark mode and an explicit constrained agent tool call. The server independently authorizes capability requests; a package manifest cannot grant authority.

### Data and maintenance

Data bindings resolve from a specific publication/release vector and permitted fact/evidence graph. Configuration edits create versioned component patches. Update invalidation uses dependency IDs, never indiscriminate whole-page regeneration. Human-owned props survive automatic updates unless invalidated with an explicit conflict. Missing optional resources leave an honest inert/readable fallback, not a broken page or fake success.

### Cost and tools

Pure/local interaction must never invoke a model by accident. Any model, remote query or executor call must reserve approved budget before dispatch. Public visitors do not inherit owner resources. The component may call only named tools in its signed manifest with valid typed inputs. A cancelled job stops polling and closes resources. No component gets platform administration, raw credentials or an unlimited execution loop.

### Native renderer block

`packages/renderer` renders a `cards` block from the document IR: each child becomes an `<article class="ds-card">` with an `<h3>` title drawn from `label`/`title`/`summary` and an optional safe `href`. Production props for a packaged instance remain normative in `../contracts/component-props/cards.schema.json`.

#### Native block props

| prop | type | required | behaviour |
| --- | --- | --- | --- |
| `title` | string | no | Optional `aria-label` on the cards region. |
| `columns` | integer | no | 1–4 visual columns exposed as `data-columns`; out-of-range values are ignored. |
| `children` | DocBlock[] | yes | One card per child. Empty children or a non-array value degrades to the labelled fallback. |
| `children[].props.href` | string | no | Card link. Only `http(s):`, `mailto:`, site-absolute `/...` and `#fragment` URLs render; anything else (for example `javascript:`) is dropped by URL policy. |

Markdown flattens the block to a titled list (`- **Label**`) with the card body nested under its item; link targets stay HTML-only metadata.

#### Example

```json
{
  "type": "cards",
  "props": { "title": "Explore", "columns": 2 },
  "children": [
    { "type": "prose", "props": { "label": "Guides", "href": "/guides", "text": "Task-oriented walkthroughs." } },
    { "type": "prose", "props": { "label": "Reference", "text": "Component reference." } }
  ]
}
```

## Package manifest

Protocol fixture: `packages/contracts/component-fixtures/cards.json`.

| Field | Value |
| --- | --- |
| Name | @docsloth/cards |
| Version | 1.0.0 |
| Protocol | 1.x |
| License | Apache-2.0 |
| Runtime | react |
| Entry | dist/index.js |
| Recording policy | masked |
| Fallback | html, markdown, json |
| Network hosts | none |
| Production write | no |
| Max runtime seconds | 0 |
| Integrity | all zeros (protocol fixture placeholder) |

## Sources

| Source | Path |
| --- | --- |
| Component page | https://registry.docsloth.dev/components/cards.html |
| Markdown twin | https://registry.docsloth.dev/docs/cards.md |
| LLM index | https://registry.docsloth.dev/llms.txt |
| Specification | packages/contracts/component-specs/cards.md |
| Prop schema | packages/contracts/component-props/cards.schema.json |
| Protocol fixture | packages/contracts/component-fixtures/cards.json |
| Catalog | packages/contracts/component-catalog.json |


---

# breadcrumbs

Show page hierarchy

| Field | Value |
| --- | --- |
| Trust class | pure |
| Implementation status | implemented_native |
| Renderer | native block |
| Key prop (production schema) | items |
| Key prop (protocol fixture) | items |
| Tools | none |
| Package version | 1.0.0 |
| Package digest | sha256:eb968b49affbedc914698148b90ef848c5836bf91c6bcba8f3d5b0af5269fca6 |

## Install

```sh
docsloth component add @docsloth/breadcrumbs@1.0.0
```

Live package: sha256:eb968b49affbedc914698148b90ef848c5836bf91c6bcba8f3d5b0af5269fca6 with 2 file digest(s); the catalog entry is generated from the built package, not a placeholder.

## Props

The prop schema is normative in `packages/contracts/component-props/breadcrumbs.schema.json`.

| Prop | Type | Required | Constraints |
| --- | --- | --- | --- |
| `title` | string | no | maxLength: 160 |
| `items` | array<object> | yes |  |

Example props generated from this schema:

```json
{
  "title": "example-title",
  "items": [
    {
      "label": "example-label",
      "href": "example-href"
    }
  ]
}
```

Required props: items.

## Example

Example document IR (the block the renderer consumes):

```json
{
  "type": "breadcrumbs",
  "props": {
    "title": "example-title",
    "items": [
      {
        "label": "example-label",
        "href": "example-href"
      }
    ]
  }
}
```

Renderer HTML (entities decoded and wrapped for display):

```html
<nav class="ds-block ds-breadcrumbs" data-component="breadcrumbs" aria-labelledby="b-title">
<h3 class="ds-block-title" id="b-title">example-title</h3>
<ol class="ds-trail">
<li>
<a href="example-href" aria-current="page">example-label</a>
</li>
</ol>
</nav>
```

Preview (interface-only; the markup above is the same output):

The renderer resolves this component as a native block; the preview above is its real HTML output, and Markdown parity for native blocks is covered by the renderer test suite.

## Specification

Generated from `packages/contracts/component-specs/breadcrumbs.md`.

### Contract

Production props are normative in `../contracts/component-props/breadcrumbs.schema.json`. The corresponding `component-fixtures` manifest is only a minimal protocol fixture; use the production props schema when building the published package. The packaged artifact ships exactly its generated `component-package.json` manifest plus `props.schema.json` (the production props schema, copied byte-for-byte) and `spec.md` (this spec, copied byte-for-byte); it contains no executable payload, fallback implementation, Storybook, test suite, SSR harness or README. Rendering behavior and the acceptance cases below belong to the renderer and the repository tests, not to the package. Installation pins the package version and the digest of every shipped byte.

### Intended behavior

Actual hierarchy with last item current, no duplicate invisible SEO links.

### React rendering

The React component renders production `items` as a labelled navigation landmark with an ordered list of links. Only the final visible item is marked `aria-current="page"`. HTTP(S) and relative web destinations are accepted; executable schemes and credential-bearing URLs remain readable labels without links. Empty trails and repeated normalized destinations show an unavailable state. The navigation compiler remains responsible for graph-wide cycle checks.

A trail with at least two items and valid ancestor destinations emits one [Schema.org BreadcrumbList](https://schema.org/BreadcrumbList) using exactly the visible labels, order and validated URLs. Missing ancestor destinations omit structured data; an unlinked final item represents the current page. Relative links and JSON-LD identifiers resolve against the hosting document. JSON serialization escapes HTML delimiters so labels cannot close the data script. Navigation works in server-rendered output without JavaScript.

### Failure and fallback

Cycles rejected by navigation compiler.

### Required acceptance cases

Breadcrumb JSON-LD equals visible hierarchy. Also test empty data, loading, denied access, browser without JS, mobile 360px, keyboard navigation, dark mode and an explicit constrained agent tool call. The server independently authorizes capability requests; a package manifest cannot grant authority.

### Data and maintenance

Data bindings resolve from a specific publication/release vector and permitted fact/evidence graph. Configuration edits create versioned component patches. Update invalidation uses dependency IDs, never indiscriminate whole-page regeneration. Human-owned props survive automatic updates unless invalidated with an explicit conflict. Missing optional resources leave an honest inert/readable fallback, not a broken page or fake success.

### Cost and tools

Pure/local interaction must never invoke a model by accident. Any model, remote query or executor call must reserve approved budget before dispatch. Public visitors do not inherit owner resources. The component may call only named tools in its signed manifest with valid typed inputs. A cancelled job stops polling and closes resources. No component gets platform administration, raw credentials or an unlimited execution loop.

## Package manifest

Protocol fixture: `packages/contracts/component-fixtures/breadcrumbs.json`.

| Field | Value |
| --- | --- |
| Name | @docsloth/breadcrumbs |
| Version | 1.0.0 |
| Protocol | 1.x |
| License | Apache-2.0 |
| Runtime | react |
| Entry | dist/index.js |
| Recording policy | masked |
| Fallback | html, markdown, json |
| Network hosts | none |
| Production write | no |
| Max runtime seconds | 0 |
| Integrity | all zeros (protocol fixture placeholder) |

## Sources

| Source | Path |
| --- | --- |
| Component page | https://registry.docsloth.dev/components/breadcrumbs.html |
| Markdown twin | https://registry.docsloth.dev/docs/breadcrumbs.md |
| LLM index | https://registry.docsloth.dev/llms.txt |
| Specification | packages/contracts/component-specs/breadcrumbs.md |
| Prop schema | packages/contracts/component-props/breadcrumbs.schema.json |
| Protocol fixture | packages/contracts/component-fixtures/breadcrumbs.json |
| Catalog | packages/contracts/component-catalog.json |


---

# version-selector

Choose an actual available release

| Field | Value |
| --- | --- |
| Trust class | interactive |
| Implementation status | implemented_native |
| Renderer | native block |
| Key prop (production schema) | versions |
| Key prop (protocol fixture) | version |
| Tools | select |
| Package version | 1.0.0 |
| Package digest | sha256:124601d299ec95bd125c64333bd74d0b2536584b4fb2977c6c7a9508de5a6f5d |

## Install

```sh
docsloth component add @docsloth/version-selector@1.0.0
```

Live package: sha256:124601d299ec95bd125c64333bd74d0b2536584b4fb2977c6c7a9508de5a6f5d with 2 file digest(s); the catalog entry is generated from the built package, not a placeholder.

## Props

The prop schema is normative in `packages/contracts/component-props/version-selector.schema.json`.

| Prop | Type | Required | Constraints |
| --- | --- | --- | --- |
| `title` | string | no | maxLength: 160 |
| `versions` | array<object> | yes |  |
| `current` | string | yes | maxLength: 256 |

Example props generated from this schema:

```json
{
  "title": "example-title",
  "versions": [
    {
      "id": "example-id",
      "label": "example-label",
      "href": "example-href",
      "deprecated": true
    }
  ],
  "current": "example-current"
}
```

Required props: versions, current.

## Example

Example document IR (the block the renderer consumes):

```json
{
  "type": "version-selector",
  "props": {
    "title": "example-title",
    "versions": [
      {
        "id": "example-id",
        "label": "example-label",
        "href": "example-href",
        "deprecated": true
      }
    ],
    "current": "example-current"
  }
}
```

Renderer HTML (entities decoded and wrapped for display):

```html
<nav class="ds-block ds-version-selector" data-component="version-selector" aria-labelledby="b-title">
<h3 class="ds-block-title" id="b-title">example-title</h3>
<ul class="ds-list">
<li>
<a href="example-href">example-label</a> (deprecated)</li>
</ul>
</nav>
```

Preview (interface-only; the markup above is the same output):

The renderer resolves this component as a native block; the preview above is its real HTML output, and Markdown parity for native blocks is covered by the renderer test suite.

## Specification

Generated from `packages/contracts/component-specs/version-selector.md`.

### Contract

Production props are normative in `../contracts/component-props/version-selector.schema.json`. The corresponding `component-fixtures` manifest is only a minimal protocol fixture; use the production props schema when building the published package. The packaged artifact ships exactly its generated `component-package.json` manifest plus `props.schema.json` (the production props schema, copied byte-for-byte) and `spec.md` (this spec, copied byte-for-byte); it contains no executable payload, fallback implementation, Storybook, test suite, SSR harness or README. Rendering behavior and the acceptance cases below belong to the renderer and the repository tests, not to the package. Installation pins the package version and the digest of every shipped byte.

### Intended behavior

Choose available release; preserve equivalent page only when mapping exists.

### Failure and fallback

Missing page navigates version home with notice, not incorrect equivalent.

### Required acceptance cases

Current page and context endpoints use selected version. Also test empty data, loading, denied access, browser without JS, mobile 360px, keyboard navigation, dark mode and an explicit constrained agent tool call. The server independently authorizes capability requests; a package manifest cannot grant authority.

### Data and maintenance

Data bindings resolve from a specific publication/release vector and permitted fact/evidence graph. Configuration edits create versioned component patches. Update invalidation uses dependency IDs, never indiscriminate whole-page regeneration. Human-owned props survive automatic updates unless invalidated with an explicit conflict. Missing optional resources leave an honest inert/readable fallback, not a broken page or fake success.

### Cost and tools

Pure/local interaction must never invoke a model by accident. Any model, remote query or executor call must reserve approved budget before dispatch. Public visitors do not inherit owner resources. The component may call only named tools in its signed manifest with valid typed inputs. A cancelled job stops polling and closes resources. No component gets platform administration, raw credentials or an unlimited execution loop.

## Package manifest

Protocol fixture: `packages/contracts/component-fixtures/version-selector.json`.

| Field | Value |
| --- | --- |
| Name | @docsloth/version-selector |
| Version | 1.0.0 |
| Protocol | 1.x |
| License | Apache-2.0 |
| Runtime | react |
| Entry | dist/index.js |
| Recording policy | masked |
| Fallback | html, markdown, json |
| Network hosts | none |
| Production write | no |
| Max runtime seconds | 0 |
| Integrity | all zeros (protocol fixture placeholder) |

| Tool | Effect | Confirmation | Input |
| --- | --- | --- | --- |
| select | local_write | no | value |

## Sources

| Source | Path |
| --- | --- |
| Component page | https://registry.docsloth.dev/components/version-selector.html |
| Markdown twin | https://registry.docsloth.dev/docs/version-selector.md |
| LLM index | https://registry.docsloth.dev/llms.txt |
| Specification | packages/contracts/component-specs/version-selector.md |
| Prop schema | packages/contracts/component-props/version-selector.schema.json |
| Protocol fixture | packages/contracts/component-fixtures/version-selector.json |
| Catalog | packages/contracts/component-catalog.json |


---

# locale-selector

Choose an available language

| Field | Value |
| --- | --- |
| Trust class | interactive |
| Implementation status | implemented_native |
| Renderer | native block |
| Key prop (production schema) | locales |
| Key prop (protocol fixture) | locale |
| Tools | select |
| Package version | 1.0.0 |
| Package digest | sha256:e44ff75e611cc9dc17b15b7b1b345e9a6d535f05ad3c248101213d9df16e4642 |

## Install

```sh
docsloth component add @docsloth/locale-selector@1.0.0
```

Live package: sha256:e44ff75e611cc9dc17b15b7b1b345e9a6d535f05ad3c248101213d9df16e4642 with 2 file digest(s); the catalog entry is generated from the built package, not a placeholder.

## Props

The prop schema is normative in `packages/contracts/component-props/locale-selector.schema.json`.

| Prop | Type | Required | Constraints |
| --- | --- | --- | --- |
| `title` | string | no | maxLength: 160 |
| `locales` | array<object> | yes |  |
| `current` | string | yes | maxLength: 256 |

Example props generated from this schema:

```json
{
  "title": "example-title",
  "locales": [
    {
      "tag": "example-tag",
      "label": "example-label",
      "href": "example-href"
    }
  ],
  "current": "example-current"
}
```

Required props: locales, current.

## Example

Example document IR (the block the renderer consumes):

```json
{
  "type": "locale-selector",
  "props": {
    "title": "example-title",
    "locales": [
      {
        "tag": "example-tag",
        "label": "example-label",
        "href": "example-href"
      }
    ],
    "current": "example-current"
  }
}
```

Renderer HTML (entities decoded and wrapped for display):

```html
<nav class="ds-block ds-locale-selector" data-component="locale-selector" aria-labelledby="b-title">
<h3 class="ds-block-title" id="b-title">example-title</h3>
<ul class="ds-list">
<li>
<a href="example-href" hreflang="example-tag" lang="example-tag">example-label</a>
</li>
</ul>
</nav>
```

Preview (interface-only; the markup above is the same output):

The renderer resolves this component as a native block; the preview above is its real HTML output, and Markdown parity for native blocks is covered by the renderer test suite.

## Specification

Generated from `packages/contracts/component-specs/locale-selector.md`.

### Contract

Production props are normative in `../contracts/component-props/locale-selector.schema.json`. The corresponding `component-fixtures` manifest is only a minimal protocol fixture; use the production props schema when building the published package. The packaged artifact ships exactly its generated `component-package.json` manifest plus `props.schema.json` (the production props schema, copied byte-for-byte) and `spec.md` (this spec, copied byte-for-byte); it contains no executable payload, fallback implementation, Storybook, test suite, SSR harness or README. Rendering behavior and the acceptance cases below belong to the renderer and the repository tests, not to the package. Installation pins the package version and the digest of every shipped byte.

### Intended behavior

Language chosen explicitly; missing translation labels original locale, no incorrect hreflang.

### Failure and fallback

RTL layout follows declared locale.

### Required acceptance cases

No duplicated unsupported-language routes. Also test empty data, loading, denied access, browser without JS, mobile 360px, keyboard navigation, dark mode and an explicit constrained agent tool call. The server independently authorizes capability requests; a package manifest cannot grant authority.

### Data and maintenance

Data bindings resolve from a specific publication/release vector and permitted fact/evidence graph. Configuration edits create versioned component patches. Update invalidation uses dependency IDs, never indiscriminate whole-page regeneration. Human-owned props survive automatic updates unless invalidated with an explicit conflict. Missing optional resources leave an honest inert/readable fallback, not a broken page or fake success.

### Cost and tools

Pure/local interaction must never invoke a model by accident. Any model, remote query or executor call must reserve approved budget before dispatch. Public visitors do not inherit owner resources. The component may call only named tools in its signed manifest with valid typed inputs. A cancelled job stops polling and closes resources. No component gets platform administration, raw credentials or an unlimited execution loop.

## Package manifest

Protocol fixture: `packages/contracts/component-fixtures/locale-selector.json`.

| Field | Value |
| --- | --- |
| Name | @docsloth/locale-selector |
| Version | 1.0.0 |
| Protocol | 1.x |
| License | Apache-2.0 |
| Runtime | react |
| Entry | dist/index.js |
| Recording policy | masked |
| Fallback | html, markdown, json |
| Network hosts | none |
| Production write | no |
| Max runtime seconds | 0 |
| Integrity | all zeros (protocol fixture placeholder) |

| Tool | Effect | Confirmation | Input |
| --- | --- | --- | --- |
| select | local_write | no | value |

## Sources

| Source | Path |
| --- | --- |
| Component page | https://registry.docsloth.dev/components/locale-selector.html |
| Markdown twin | https://registry.docsloth.dev/docs/locale-selector.md |
| LLM index | https://registry.docsloth.dev/llms.txt |
| Specification | packages/contracts/component-specs/locale-selector.md |
| Prop schema | packages/contracts/component-props/locale-selector.schema.json |
| Protocol fixture | packages/contracts/component-fixtures/locale-selector.json |
| Catalog | packages/contracts/component-catalog.json |


---

# copy-context

Export permitted agent context

| Field | Value |
| --- | --- |
| Trust class | connected |
| Implementation status | implemented_native |
| Renderer | native block |
| Key prop (production schema) | publication_id |
| Key prop (protocol fixture) | task |
| Tools | prepare, copy |
| Package version | 1.0.0 |
| Package digest | sha256:7384e22a62ec776e506652088611bb91cc03f1585c67a5046ac388fdbfe19a90 |

## Install

```sh
docsloth component add @docsloth/copy-context@1.0.0
```

Live package: sha256:7384e22a62ec776e506652088611bb91cc03f1585c67a5046ac388fdbfe19a90 with 2 file digest(s); the catalog entry is generated from the built package, not a placeholder.

## Props

The prop schema is normative in `packages/contracts/component-props/copy-context.schema.json`.

| Prop | Type | Required | Constraints |
| --- | --- | --- | --- |
| `title` | string | no | maxLength: 160 |
| `publication_id` | string | yes | format: uuid |
| `page_ids` | array<string> | yes |  |
| `format` | "markdown" \| "json" | yes |  |
| `token_budget` | integer | yes |  |

Example props generated from this schema:

```json
{
  "title": "example-title",
  "publication_id": "00000000-0000-4000-8000-000000000000",
  "page_ids": [
    "00000000-0000-4000-8000-000000000000"
  ],
  "format": "markdown",
  "token_budget": 256
}
```

Required props: publication_id, page_ids, format, token_budget.

## Example

Example document IR (the block the renderer consumes):

```json
{
  "type": "copy-context",
  "props": {
    "title": "example-title",
    "publication_id": "00000000-0000-4000-8000-000000000000",
    "page_ids": [
      "00000000-0000-4000-8000-000000000000"
    ],
    "format": "markdown",
    "token_budget": 256
  }
}
```

Renderer HTML (entities decoded and wrapped for display):

```html
<section class="ds-block ds-copy-context" data-component="copy-context" aria-labelledby="b-title">
<h3 class="ds-block-title" id="b-title">example-title</h3>
<dl class="ds-facts">
<div>
<dt>Pages</dt>
<dd>1</dd>
</div>
<div>
<dt>Format</dt>
<dd>markdown</dd>
</div>
<div>
<dt>Token budget</dt>
<dd>256</dd>
</div>
</dl>
<p class="ds-live-note" role="note">Copying this context needs the live documentation site.</p>
</section>
```

Preview (interface-only; the markup above is the same output):

The renderer resolves this component as a native block; the preview above is its real HTML output, and Markdown parity for native blocks is covered by the renderer test suite.

## Specification

Generated from `packages/contracts/component-specs/copy-context.md`.

### Contract

Production props are normative in `../contracts/component-props/copy-context.schema.json`. The corresponding `component-fixtures` manifest is only a minimal protocol fixture; use the production props schema when building the published package. The packaged artifact ships exactly its generated `component-package.json` manifest plus `props.schema.json` (the production props schema, copied byte-for-byte) and `spec.md` (this spec, copied byte-for-byte); it contains no executable payload, fallback implementation, Storybook, test suite, SSR harness or README. Rendering behavior and the acceptance cases below belong to the renderer and the repository tests, not to the package. Installation pins the package version and the digest of every shipped byte.

### Intended behavior

Prepare scoped context with source/version/constraints and copy exact content.

### Failure and fallback

No transcript/system instructions/private data appended.

### Required acceptance cases

Token limit and complete provenance for included facts. Also test empty data, loading, denied access, browser without JS, mobile 360px, keyboard navigation, dark mode and an explicit constrained agent tool call. The server independently authorizes capability requests; a package manifest cannot grant authority.

### Data and maintenance

Data bindings resolve from a specific publication/release vector and permitted fact/evidence graph. Configuration edits create versioned component patches. Update invalidation uses dependency IDs, never indiscriminate whole-page regeneration. Human-owned props survive automatic updates unless invalidated with an explicit conflict. Missing optional resources leave an honest inert/readable fallback, not a broken page or fake success.

### Cost and tools

Pure/local interaction must never invoke a model by accident. Any model, remote query or executor call must reserve approved budget before dispatch. Public visitors do not inherit owner resources. The component may call only named tools in its signed manifest with valid typed inputs. A cancelled job stops polling and closes resources. No component gets platform administration, raw credentials or an unlimited execution loop.

### React host integration

Production props select a publication, at most 100 unique page UUIDs, Markdown or JSON format, and a 256–32768 token budget. The optional title is presentation only. `ComponentContentProvider.copyContexts` uses `copyContextKey` with sorted page IDs. Available records and packets must match release, publication, pages, format, budget, reader session and context version exactly.

An optional host `prepare` adapter receives only that scope plus an AbortSignal. The host authorizes the audience, reserves any query/model budget, selects only permitted facts and constraints, and counts the **exact** `copyContextDocument` bytes with its named tokenizer. `ContextPacket.tokenCount` is host-reported; the renderer checks its integer range against the budget but does not independently verify tokenizer accuracy. The host must count the serialized document, including metadata and provenance, rather than just the fact text. No preparation runs on mount; there is no generic executor request, transcript collection or automatic clipboard write.

Packets contain at most 128 uniquely identified facts, each with a selected page ID, source ID, immutable source version and up to 4096 UTF-16 units of text. At most 16 explicit constraints of 2000 units each are accepted. The complete serialized document must fit 128 KiB of UTF-8. Unknown fields are discarded; reader-session and packet-delivery metadata are excluded from the copied text. Markdown wraps the same deterministic JSON data in a fenced block. The host must authorize and remove private material before delivery; client validation cannot establish whether a host-supplied fact is public or its source is true.

Prepared content and provenance remain readable and selectable without JavaScript; prepare/copy controls are disabled during SSR. Hydration enables explicit preparation and a separate native Clipboard API action that copies exactly the displayed document. Clipboard refusal retains a manual selection fallback and never reports success. Empty selection, no facts, loading, restricted/missing bindings, denied/unsupported/rate-limited requests and invalid packets are distinct. Preparation clears old content; cancellation, scope changes and supplied-packet replacement discard late replies. Aborting a wait does not prove cancellation of remote work or undo an already-started clipboard write. Production host transport, permission enforcement and tokenizer integration remain separate integration responsibilities.

## Package manifest

Protocol fixture: `packages/contracts/component-fixtures/copy-context.json`.

| Field | Value |
| --- | --- |
| Name | @docsloth/copy-context |
| Version | 1.0.0 |
| Protocol | 1.x |
| License | Apache-2.0 |
| Runtime | react |
| Entry | dist/index.js |
| Recording policy | blocked |
| Fallback | html, markdown, json |
| Network hosts | none |
| Production write | no |
| Max runtime seconds | 120 |
| Integrity | all zeros (protocol fixture placeholder) |

| Tool | Effect | Confirmation | Input |
| --- | --- | --- | --- |
| prepare | execute | no | value |
| copy | read | no | value |

## Sources

| Source | Path |
| --- | --- |
| Component page | https://registry.docsloth.dev/components/copy-context.html |
| Markdown twin | https://registry.docsloth.dev/docs/copy-context.md |
| LLM index | https://registry.docsloth.dev/llms.txt |
| Specification | packages/contracts/component-specs/copy-context.md |
| Prop schema | packages/contracts/component-props/copy-context.schema.json |
| Protocol fixture | packages/contracts/component-fixtures/copy-context.json |
| Catalog | packages/contracts/component-catalog.json |


---

# apply-to-repo

Prepare a reader-authorized integration PR

| Field | Value |
| --- | --- |
| Trust class | agentic |
| Implementation status | implemented_native |
| Renderer | native block |
| Key prop (production schema) | example_id |
| Key prop (protocol fixture) | task |
| Tools | plan, request_approval, create_pr |
| Package version | 1.0.0 |
| Package digest | sha256:3314002b84cf7826747f990ef9777dc4b95d1475e73b8266761b5912fac5ca03 |

## Install

```sh
docsloth component add @docsloth/apply-to-repo@1.0.0
```

Live package: sha256:3314002b84cf7826747f990ef9777dc4b95d1475e73b8266761b5912fac5ca03 with 2 file digest(s); the catalog entry is generated from the built package, not a placeholder.

## Props

The prop schema is normative in `packages/contracts/component-props/apply-to-repo.schema.json`.

| Prop | Type | Required | Constraints |
| --- | --- | --- | --- |
| `title` | string | no | maxLength: 160 |
| `example_id` | string | yes | format: uuid |
| `supported_languages` | array<string> | yes |  |
| `requested_permissions` | array<string> | yes |  |
| `resource` | object | no | additionalProperties: false |
| `resource.resource_id` | string | yes | format: uuid |
| `resource.operation` | string | yes | maxLength: 160 |
| `resource.environment` | "test" \| "staging" \| "production" | yes |  |

Example props generated from this schema:

```json
{
  "title": "example-title",
  "example_id": "00000000-0000-4000-8000-000000000000",
  "supported_languages": [
    "example-supported_languages"
  ],
  "requested_permissions": [
    "example-requested_permissions"
  ],
  "resource": {
    "resource_id": "00000000-0000-4000-8000-000000000000",
    "operation": "example-operation",
    "environment": "test"
  }
}
```

Required props: example_id, supported_languages, requested_permissions.

## Example

Example document IR (the block the renderer consumes):

```json
{
  "type": "apply-to-repo",
  "props": {
    "title": "example-title",
    "example_id": "00000000-0000-4000-8000-000000000000",
    "supported_languages": [
      "example-supported_languages"
    ],
    "requested_permissions": [
      "example-requested_permissions"
    ],
    "resource": {
      "resource_id": "00000000-0000-4000-8000-000000000000",
      "operation": "example-operation",
      "environment": "test"
    }
  }
}
```

Renderer HTML (entities decoded and wrapped for display):

```html
<section class="ds-block ds-apply-to-repo" data-component="apply-to-repo" aria-labelledby="b-title">
<h3 class="ds-block-title" id="b-title">example-title</h3>
<dl class="ds-facts">
<div>
<dt>Languages</dt>
<dd>
<code>example-supported_languages</code>
</dd>
</div>
<div>
<dt>Permissions requested</dt>
<dd>
<code>example-requested_permissions</code>
</dd>
</div>
<div>
<dt>Runs</dt>
<dd>
<code>example-operation</code> in the test environment</dd>
</div>
</dl>
<p class="ds-live-note" role="note">Applying this example to a repository needs the live documentation site and your approval.</p>
</section>
```

Preview (interface-only; the markup above is the same output):

The renderer resolves this component as a native block; the preview above is its real HTML output, and Markdown parity for native blocks is covered by the renderer test suite.

## Specification

Generated from `packages/contracts/component-specs/apply-to-repo.md`.

### Contract

Production props are normative in `../contracts/component-props/apply-to-repo.schema.json`. The corresponding `component-fixtures` manifest is only a minimal protocol fixture; use the production props schema when building the published package. The packaged artifact ships exactly its generated `component-package.json` manifest plus `props.schema.json` (the production props schema, copied byte-for-byte) and `spec.md` (this spec, copied byte-for-byte); it contains no executable payload, fallback implementation, Storybook, test suite, SSR harness or README. Rendering behavior and the acceptance cases below belong to the renderer and the repository tests, not to the package. Installation pins the package version and the digest of every shipped byte.

### Intended behavior

Read/analyze recipient-selected repo, show patch and tests, explicit PR creation; no push/merge.

### Failure and fallback

Unsupported stack yields bounded explanation/portable example, no secret upload.

### Required acceptance cases

Credentials acquired only after real reader authorization; repository selection not inferred. Also test empty data, loading, denied access, browser without JS, mobile 360px, keyboard navigation, dark mode and an explicit constrained agent tool call. The server independently authorizes capability requests; a package manifest cannot grant authority.

### Data and maintenance

Data bindings resolve from a specific publication/release vector and permitted fact/evidence graph. Configuration edits create versioned component patches. Update invalidation uses dependency IDs, never indiscriminate whole-page regeneration. Human-owned props survive automatic updates unless invalidated with an explicit conflict. Missing optional resources leave an honest inert/readable fallback, not a broken page or fake success.

### Cost and tools

Pure/local interaction must never invoke a model by accident. Any model, remote query or executor call must reserve approved budget before dispatch. Public visitors do not inherit owner resources. The component may call only named tools in its signed manifest with valid typed inputs. A cancelled job stops polling and closes resources. No component gets platform administration, raw credentials or an unlimited execution loop.

## Package manifest

Protocol fixture: `packages/contracts/component-fixtures/apply-to-repo.json`.

| Field | Value |
| --- | --- |
| Name | @docsloth/apply-to-repo |
| Version | 1.0.0 |
| Protocol | 1.x |
| License | Apache-2.0 |
| Runtime | react |
| Entry | dist/index.js |
| Recording policy | blocked |
| Fallback | html, markdown, json |
| Network hosts | none |
| Production write | no |
| Max runtime seconds | 120 |
| Integrity | all zeros (protocol fixture placeholder) |

| Tool | Effect | Confirmation | Input |
| --- | --- | --- | --- |
| plan | read | no | value |
| request_approval | read | no | value |
| create_pr | external_write | yes | value |

## Sources

| Source | Path |
| --- | --- |
| Component page | https://registry.docsloth.dev/components/apply-to-repo.html |
| Markdown twin | https://registry.docsloth.dev/docs/apply-to-repo.md |
| LLM index | https://registry.docsloth.dev/llms.txt |
| Specification | packages/contracts/component-specs/apply-to-repo.md |
| Prop schema | packages/contracts/component-props/apply-to-repo.schema.json |
| Protocol fixture | packages/contracts/component-fixtures/apply-to-repo.json |
| Catalog | packages/contracts/component-catalog.json |


---

# embed

Isolated approved external UI

| Field | Value |
| --- | --- |
| Trust class | connected |
| Implementation status | implemented_native |
| Renderer | native block |
| Key prop (production schema) | src |
| Key prop (protocol fixture) | src |
| Tools | load, reset |
| Package version | 1.0.0 |
| Package digest | sha256:77645d8b323a2fc823f0ee64f5cfcf88936293b704a174807e56a284dd2a1f11 |

## Install

```sh
docsloth component add @docsloth/embed@1.0.0
```

Live package: sha256:77645d8b323a2fc823f0ee64f5cfcf88936293b704a174807e56a284dd2a1f11 with 2 file digest(s); the catalog entry is generated from the built package, not a placeholder.

## Props

The prop schema is normative in `packages/contracts/component-props/embed.schema.json`.

| Prop | Type | Required | Constraints |
| --- | --- | --- | --- |
| `title` | string | yes |  |
| `src` | string | yes | format: uri |
| `sandbox_flags` | array<"allow-scripts" \| "allow-forms" \| "allow-downloads"> | yes |  |
| `height` | integer | yes |  |

Example props generated from this schema:

```json
{
  "title": "example-title",
  "src": "https://example.com/src",
  "sandbox_flags": [
    "allow-scripts"
  ],
  "height": 100
}
```

Required props: src, title, sandbox_flags, height.

## Example

Example document IR (the block the renderer consumes):

```json
{
  "type": "embed",
  "props": {
    "title": "example-title",
    "src": "https://example.com/src",
    "sandbox_flags": [
      "allow-scripts"
    ],
    "height": 100
  }
}
```

Renderer HTML (entities decoded and wrapped for display):

```html
<section class="ds-block ds-embed" data-component="embed" aria-labelledby="b-title">
<h3 class="ds-block-title" id="b-title">example-title</h3>
<p>
<a href="https://example.com/src" rel="noopener noreferrer">example-title</a>
</p>
<p class="ds-live-note" role="note">Embedded content is not loaded inside this page; open it on its own site.</p>
</section>
```

Preview (interface-only; the markup above is the same output):

The renderer resolves this component as a native block; the preview above is its real HTML output, and Markdown parity for native blocks is covered by the renderer test suite.

## Specification

Generated from `packages/contracts/component-specs/embed.md`.

### Contract

Production props are normative in `../contracts/component-props/embed.schema.json`. The corresponding `component-fixtures` manifest is only a minimal protocol fixture; use the production props schema when building the published package. The packaged artifact ships exactly its generated `component-package.json` manifest plus `props.schema.json` (the production props schema, copied byte-for-byte) and `spec.md` (this spec, copied byte-for-byte); it contains no executable payload, fallback implementation, Storybook, test suite, SSR harness or README. Rendering behavior and the acceptance cases below belong to the renderer and the repository tests, not to the package. Installation pins the package version and the digest of every shipped byte.

### Intended behavior

Allowlisted isolated external origin, strict postMessage origin+nonce schema, no allow-same-origin for untrusted iframe.

### Failure and fallback

Blocked origin renders safe link.

### Required acceptance cases

No top navigation, popup, token storage or parent DOM access. Also test empty data, loading, denied access, browser without JS, mobile 360px, keyboard navigation, dark mode and an explicit constrained agent tool call. The server independently authorizes capability requests; a package manifest cannot grant authority.

### Data and maintenance

Data bindings resolve from a specific publication/release vector and permitted fact/evidence graph. Configuration edits create versioned component patches. Update invalidation uses dependency IDs, never indiscriminate whole-page regeneration. Human-owned props survive automatic updates unless invalidated with an explicit conflict. Missing optional resources leave an honest inert/readable fallback, not a broken page or fake success.

### Cost and tools

Pure/local interaction must never invoke a model by accident. Any model, remote query or executor call must reserve approved budget before dispatch. Public visitors do not inherit owner resources. The component may call only named tools in its signed manifest with valid typed inputs. A cancelled job stops polling and closes resources. No component gets platform administration, raw credentials or an unlimited execution loop.

## Package manifest

Protocol fixture: `packages/contracts/component-fixtures/embed.json`.

| Field | Value |
| --- | --- |
| Name | @docsloth/embed |
| Version | 1.0.0 |
| Protocol | 1.x |
| License | Apache-2.0 |
| Runtime | react |
| Entry | dist/index.js |
| Recording policy | blocked |
| Fallback | html, markdown, json |
| Network hosts | none |
| Production write | no |
| Max runtime seconds | 120 |
| Integrity | all zeros (protocol fixture placeholder) |

| Tool | Effect | Confirmation | Input |
| --- | --- | --- | --- |
| load | read | no | value |
| reset | local_write | no | value |

## Sources

| Source | Path |
| --- | --- |
| Component page | https://registry.docsloth.dev/components/embed.html |
| Markdown twin | https://registry.docsloth.dev/docs/embed.md |
| LLM index | https://registry.docsloth.dev/llms.txt |
| Specification | packages/contracts/component-specs/embed.md |
| Prop schema | packages/contracts/component-props/embed.schema.json |
| Protocol fixture | packages/contracts/component-fixtures/embed.json |
| Catalog | packages/contracts/component-catalog.json |


---

# metrics

Display authorized aggregate metrics

| Field | Value |
| --- | --- |
| Trust class | connected |
| Implementation status | implemented_native |
| Renderer | native block |
| Key prop (production schema) | resource |
| Key prop (protocol fixture) | query |
| Tools | refresh |
| Package version | 1.0.0 |
| Package digest | sha256:689a423f12cd771fdaf04d7594cc40c7d1637af313bb32b4d64830a20f2cbc35 |

## Install

```sh
docsloth component add @docsloth/metrics@1.0.0
```

Live package: sha256:689a423f12cd771fdaf04d7594cc40c7d1637af313bb32b4d64830a20f2cbc35 with 2 file digest(s); the catalog entry is generated from the built package, not a placeholder.

## Props

The prop schema is normative in `packages/contracts/component-props/metrics.schema.json`.

| Prop | Type | Required | Constraints |
| --- | --- | --- | --- |
| `title` | string | no | maxLength: 160 |
| `resource` | object | yes | additionalProperties: false |
| `resource.resource_id` | string | yes | format: uuid |
| `resource.operation` | string | yes | maxLength: 160 |
| `resource.environment` | "test" \| "staging" \| "production" | yes |  |
| `query_id` | string | yes | maxLength: 256 |
| `display` | "number" \| "line" \| "bar" \| "table" | yes |  |
| `time_range` | "24h" \| "7d" \| "30d" | yes |  |

Example props generated from this schema:

```json
{
  "title": "example-title",
  "resource": {
    "resource_id": "00000000-0000-4000-8000-000000000000",
    "operation": "example-operation",
    "environment": "test"
  },
  "query_id": "example-query_id",
  "display": "number",
  "time_range": "24h"
}
```

Required props: resource, query_id, display, time_range.

## Example

Example document IR (the block the renderer consumes):

```json
{
  "type": "metrics",
  "props": {
    "title": "example-title",
    "resource": {
      "resource_id": "00000000-0000-4000-8000-000000000000",
      "operation": "example-operation",
      "environment": "test"
    },
    "query_id": "example-query_id",
    "display": "number",
    "time_range": "24h"
  }
}
```

Renderer HTML (entities decoded and wrapped for display):

```html
<section class="ds-block ds-metrics" data-component="metrics" aria-labelledby="b-title">
<h3 class="ds-block-title" id="b-title">example-title</h3>
<dl class="ds-facts">
<div>
<dt>Metric query</dt>
<dd>
<code>example-query_id</code>
</dd>
</div>
<div>
<dt>Display</dt>
<dd>number</dd>
</div>
<div>
<dt>Time range</dt>
<dd>24h</dd>
</div>
<div>
<dt>Runs</dt>
<dd>
<code>example-operation</code> in the test environment</dd>
</div>
</dl>
<p class="ds-live-note" role="note">Metric values are loaded on the live documentation site.</p>
</section>
```

Preview (interface-only; the markup above is the same output):

The renderer resolves this component as a native block; the preview above is its real HTML output, and Markdown parity for native blocks is covered by the renderer test suite.

## Specification

Generated from `packages/contracts/component-specs/metrics.md`.

### Contract

Production props are normative in `../contracts/component-props/metrics.schema.json`. The corresponding `component-fixtures` manifest is only a minimal protocol fixture; use the production props schema when building the published package. The packaged artifact ships exactly its generated `component-package.json` manifest plus `props.schema.json` (the production props schema, copied byte-for-byte) and `spec.md` (this spec, copied byte-for-byte); it contains no executable payload, fallback implementation, Storybook, test suite, SSR harness or README. Rendering behavior and the acceptance cases below belong to the renderer and the repository tests, not to the package. Installation pins the package version and the digest of every shipped byte.

### Intended behavior

Authorized aggregates with explicit units, time bounds and coverage.

### Failure and fallback

Partial data label retained; low-count privacy suppression.

### Required acceptance cases

No unjustified conversion attribution or individual behavior leak. Also test empty data, loading, denied access, browser without JS, mobile 360px, keyboard navigation, dark mode and an explicit constrained agent tool call. The server independently authorizes capability requests; a package manifest cannot grant authority.

### Data and maintenance

Data bindings resolve from a specific publication/release vector and permitted fact/evidence graph. Configuration edits create versioned component patches. Update invalidation uses dependency IDs, never indiscriminate whole-page regeneration. Human-owned props survive automatic updates unless invalidated with an explicit conflict. Missing optional resources leave an honest inert/readable fallback, not a broken page or fake success.

### Cost and tools

Pure/local interaction must never invoke a model by accident. Any model, remote query or executor call must reserve approved budget before dispatch. Public visitors do not inherit owner resources. The component may call only named tools in its signed manifest with valid typed inputs. A cancelled job stops polling and closes resources. No component gets platform administration, raw credentials or an unlimited execution loop.

### React aggregate binding

The host provides `ComponentContentProvider.metricQueries`, keyed with `metricQueryKey(resource, query_id, time_range)` from `@docsloth/official-components/host`. The resource ID, operation, environment, query and time range must all match. An available record also names the provider release ID, metric label, units, exact UTC window bounds, complete/partial coverage, privacy minimum count (at least five), and up to 2,000 timestamped aggregate buckets. Use `{ at, suppressed: true }` for a suppressed bucket; otherwise supply `{ at, value, count }`. Window durations are exactly 24 hours, seven days or thirty days, with an exclusive end.

The server must authorize the audience/resource/query and suppress private values **before** delivery. The renderer additionally hides low-count values, but client-side hiding cannot protect bytes already delivered to a browser. No individual identifiers, raw events or suppressed values belong in this binding. Differential privacy and protection against differencing across multiple queries remain server responsibilities. A resource prop or record is not an authorization grant.

Number mode shows the latest bucket, including an explicit suppressed state. Line and bar modes include a complete accessible table in a native disclosure; line plots do not bridge suppressed buckets. Table mode renders all approved buckets. Coverage, units and time bounds remain visible in every mode without JavaScript. Missing, restricted, loading, empty and invalid snapshots have explicit states. No arbitrary execution request, model call, browser persistence, conversion attribution or fabricated empty-series zero occurs. The host supplies updated snapshots; remote query authorization, approved budget reservation, delivery and constrained agent refresh remain integration work.

## Package manifest

Protocol fixture: `packages/contracts/component-fixtures/metrics.json`.

| Field | Value |
| --- | --- |
| Name | @docsloth/metrics |
| Version | 1.0.0 |
| Protocol | 1.x |
| License | Apache-2.0 |
| Runtime | react |
| Entry | dist/index.js |
| Recording policy | blocked |
| Fallback | html, markdown, json |
| Network hosts | none |
| Production write | no |
| Max runtime seconds | 120 |
| Integrity | all zeros (protocol fixture placeholder) |

| Tool | Effect | Confirmation | Input |
| --- | --- | --- | --- |
| refresh | read | no | value |

## Sources

| Source | Path |
| --- | --- |
| Component page | https://registry.docsloth.dev/components/metrics.html |
| Markdown twin | https://registry.docsloth.dev/docs/metrics.md |
| LLM index | https://registry.docsloth.dev/llms.txt |
| Specification | packages/contracts/component-specs/metrics.md |
| Prop schema | packages/contracts/component-props/metrics.schema.json |
| Protocol fixture | packages/contracts/component-fixtures/metrics.json |
| Catalog | packages/contracts/component-catalog.json |


---

# media-transcript

Accessible transcript tied to media version

| Field | Value |
| --- | --- |
| Trust class | pure |
| Implementation status | implemented_native |
| Renderer | native block |
| Key prop (production schema) | media_asset_id |
| Key prop (protocol fixture) | text |
| Tools | none |
| Package version | 1.0.0 |
| Package digest | sha256:ed248c31e409e5b4bea5349387e161a34ebcdbb7c953269b2aa14e4c66b2c470 |

## Install

```sh
docsloth component add @docsloth/media-transcript@1.0.0
```

Live package: sha256:ed248c31e409e5b4bea5349387e161a34ebcdbb7c953269b2aa14e4c66b2c470 with 2 file digest(s); the catalog entry is generated from the built package, not a placeholder.

## Props

The prop schema is normative in `packages/contracts/component-props/media-transcript.schema.json`.

| Prop | Type | Required | Constraints |
| --- | --- | --- | --- |
| `title` | string | no | maxLength: 160 |
| `media_asset_id` | string | yes | format: uuid |
| `segments` | array<object> | yes |  |
| `locale` | string | yes |  |

Example props generated from this schema:

```json
{
  "title": "example-title",
  "media_asset_id": "00000000-0000-4000-8000-000000000000",
  "segments": [
    {
      "start_ms": 1,
      "end_ms": 1,
      "text": "example-text"
    }
  ],
  "locale": "example-locale"
}
```

Required props: media_asset_id, segments, locale.

## Example

Example document IR (the block the renderer consumes):

```json
{
  "type": "media-transcript",
  "props": {
    "title": "example-title",
    "media_asset_id": "00000000-0000-4000-8000-000000000000",
    "segments": [
      {
        "start_ms": 1,
        "end_ms": 1,
        "text": "example-text"
      }
    ],
    "locale": "example-locale"
  }
}
```

Renderer HTML (entities decoded and wrapped for display):

```html
<section class="ds-block ds-media-transcript" data-component="media-transcript" aria-labelledby="b-title" lang="example-locale">
<h3 class="ds-block-title" id="b-title">example-title</h3>
<ul class="ds-list">
<li>
<time datetime="PT0.001S">0:00</time>–<time datetime="PT0.001S">0:00</time> example-text</li>
</ul>
</section>
```

Preview (interface-only; the markup above is the same output):

The renderer resolves this component as a native block; the preview above is its real HTML output, and Markdown parity for native blocks is covered by the renderer test suite.

## Specification

Generated from `packages/contracts/component-specs/media-transcript.md`.

### Contract

Production props are normative in `../contracts/component-props/media-transcript.schema.json`. The corresponding `component-fixtures` manifest is only a minimal protocol fixture; use the production props schema when building the published package. The packaged artifact ships exactly its generated `component-package.json` manifest plus `props.schema.json` (the production props schema, copied byte-for-byte) and `spec.md` (this spec, copied byte-for-byte); it contains no executable payload, fallback implementation, Storybook, test suite, SSR harness or README. Rendering behavior and the acceptance cases below belong to the renderer and the repository tests, not to the package. Installation pins the package version and the digest of every shipped byte.

### Intended behavior

Time-aligned accessible transcript and optional seek links.

### Failure and fallback

Unreviewed transcription labelled with edit route.

### Required acceptance cases

Monotonic times and no secret-bearing recording included. Also test empty data, loading, denied access, browser without JS, mobile 360px, keyboard navigation, dark mode and an explicit constrained agent tool call. The server independently authorizes capability requests; a package manifest cannot grant authority.

### Data and maintenance

Data bindings resolve from a specific publication/release vector and permitted fact/evidence graph. Configuration edits create versioned component patches. Update invalidation uses dependency IDs, never indiscriminate whole-page regeneration. Human-owned props survive automatic updates unless invalidated with an explicit conflict. Missing optional resources leave an honest inert/readable fallback, not a broken page or fake success.

### Cost and tools

Pure/local interaction must never invoke a model by accident. Any model, remote query or executor call must reserve approved budget before dispatch. Public visitors do not inherit owner resources. The component may call only named tools in its signed manifest with valid typed inputs. A cancelled job stops polling and closes resources. No component gets platform administration, raw credentials or an unlimited execution loop.

## Package manifest

Protocol fixture: `packages/contracts/component-fixtures/media-transcript.json`.

| Field | Value |
| --- | --- |
| Name | @docsloth/media-transcript |
| Version | 1.0.0 |
| Protocol | 1.x |
| License | Apache-2.0 |
| Runtime | react |
| Entry | dist/index.js |
| Recording policy | masked |
| Fallback | html, markdown, json |
| Network hosts | none |
| Production write | no |
| Max runtime seconds | 0 |
| Integrity | all zeros (protocol fixture placeholder) |

## Sources

| Source | Path |
| --- | --- |
| Component page | https://registry.docsloth.dev/components/media-transcript.html |
| Markdown twin | https://registry.docsloth.dev/docs/media-transcript.md |
| LLM index | https://registry.docsloth.dev/llms.txt |
| Specification | packages/contracts/component-specs/media-transcript.md |
| Prop schema | packages/contracts/component-props/media-transcript.schema.json |
| Protocol fixture | packages/contracts/component-fixtures/media-transcript.json |
| Catalog | packages/contracts/component-catalog.json |


---

# faq

Task-oriented evidenced question answers

| Field | Value |
| --- | --- |
| Trust class | pure |
| Implementation status | implemented_native |
| Renderer | native block |
| Key prop (production schema) | items |
| Key prop (protocol fixture) | items |
| Tools | none |
| Package version | 1.0.0 |
| Package digest | sha256:7bb429cc396b17aaf5b0cf75973646d5c81c914b7335700cf5a973ccfb0f31e9 |

## Install

```sh
docsloth component add @docsloth/faq@1.0.0
```

Live package: sha256:7bb429cc396b17aaf5b0cf75973646d5c81c914b7335700cf5a973ccfb0f31e9 with 2 file digest(s); the catalog entry is generated from the built package, not a placeholder.

## Props

The prop schema is normative in `packages/contracts/component-props/faq.schema.json`.

| Prop | Type | Required | Constraints |
| --- | --- | --- | --- |
| `title` | string | no | maxLength: 160 |
| `items` | array<object> | yes |  |

Example props generated from this schema:

```json
{
  "title": "example-title",
  "items": [
    {
      "question": "example-question",
      "answer": "example-answer",
      "fact_ids": [
        "00000000-0000-4000-8000-000000000000"
      ]
    }
  ]
}
```

Required props: items.

## Example

Example document IR (the block the renderer consumes):

```json
{
  "type": "faq",
  "props": {
    "title": "example-title",
    "items": [
      {
        "question": "example-question",
        "answer": "example-answer",
        "fact_ids": [
          "00000000-0000-4000-8000-000000000000"
        ]
      }
    ]
  }
}
```

Renderer HTML (entities decoded and wrapped for display):

```html
<section class="ds-block ds-faq" data-component="faq" aria-labelledby="b-title">
<h3 class="ds-block-title" id="b-title">example-title</h3>
<div class="ds-group">
<h4 class="ds-block-subtitle">example-question</h4>
<p>example-answer</p>
</div>
</section>
```

Preview (interface-only; the markup above is the same output):

The renderer resolves this component as a native block; the preview above is its real HTML output, and Markdown parity for native blocks is covered by the renderer test suite.

## Specification

Generated from `packages/contracts/component-specs/faq.md`.

### Contract

Production props are normative in `../contracts/component-props/faq.schema.json`. The corresponding `component-fixtures` manifest is only a minimal protocol fixture; use the production props schema when building the published package. The packaged artifact ships exactly its generated `component-package.json` manifest plus `props.schema.json` (the production props schema, copied byte-for-byte) and `spec.md` (this spec, copied byte-for-byte); it contains no executable payload, fallback implementation, Storybook, test suite, SSR harness or README. Rendering behavior and the acceptance cases below belong to the renderer and the repository tests, not to the package. Installation pins the package version and the digest of every shipped byte.

### Intended behavior

The official React component renders the supplied title, questions and answers as escaped text in native details/summary disclosures. The native IR renderer keeps questions and answers visible as headings and paragraphs. Disclosure controls work with keyboard and without JavaScript. Evidence IDs stay metadata; rendering does not independently verify claims or emit rich-result markup.

### Failure and fallback

Unanswered questions show `Answer unavailable.`; malformed questions show `Question unavailable.` and empty data shows `No questions available.`. All supplied entries remain reachable. Long answer text wraps and preserves line breaks. No network, storage or model calls occur.

### Required acceptance cases

No fabricated support volume or unsupported schema rich-result claim. Also test empty data, loading, denied access, browser without JS, mobile 360px, keyboard navigation, dark mode and an explicit constrained agent tool call. The server independently authorizes capability requests; a package manifest cannot grant authority.

### Data and maintenance

Data bindings resolve from a specific publication/release vector and permitted fact/evidence graph. Configuration edits create versioned component patches. Update invalidation uses dependency IDs, never indiscriminate whole-page regeneration. Human-owned props survive automatic updates unless invalidated with an explicit conflict. Missing optional resources leave an honest inert/readable fallback, not a broken page or fake success.

### Cost and tools

Pure/local interaction must never invoke a model by accident. Any model, remote query or executor call must reserve approved budget before dispatch. Public visitors do not inherit owner resources. The component may call only named tools in its signed manifest with valid typed inputs. A cancelled job stops polling and closes resources. No component gets platform administration, raw credentials or an unlimited execution loop.

## Package manifest

Protocol fixture: `packages/contracts/component-fixtures/faq.json`.

| Field | Value |
| --- | --- |
| Name | @docsloth/faq |
| Version | 1.0.0 |
| Protocol | 1.x |
| License | Apache-2.0 |
| Runtime | react |
| Entry | dist/index.js |
| Recording policy | masked |
| Fallback | html, markdown, json |
| Network hosts | none |
| Production write | no |
| Max runtime seconds | 0 |
| Integrity | all zeros (protocol fixture placeholder) |

## Sources

| Source | Path |
| --- | --- |
| Component page | https://registry.docsloth.dev/components/faq.html |
| Markdown twin | https://registry.docsloth.dev/docs/faq.md |
| LLM index | https://registry.docsloth.dev/llms.txt |
| Specification | packages/contracts/component-specs/faq.md |
| Prop schema | packages/contracts/component-props/faq.schema.json |
| Protocol fixture | packages/contracts/component-fixtures/faq.json |
| Catalog | packages/contracts/component-catalog.json |


---

# glossary

Software terminology and concepts

| Field | Value |
| --- | --- |
| Trust class | interactive |
| Implementation status | implemented_native |
| Renderer | native block |
| Key prop (production schema) | items |
| Key prop (protocol fixture) | items |
| Tools | search |
| Package version | 1.0.0 |
| Package digest | sha256:4c45f87cd38b58fb19b59de4a2be037be83e84a9916428231b304342ccc9b144 |

## Install

```sh
docsloth component add @docsloth/glossary@1.0.0
```

Live package: sha256:4c45f87cd38b58fb19b59de4a2be037be83e84a9916428231b304342ccc9b144 with 2 file digest(s); the catalog entry is generated from the built package, not a placeholder.

## Props

The prop schema is normative in `packages/contracts/component-props/glossary.schema.json`.

| Prop | Type | Required | Constraints |
| --- | --- | --- | --- |
| `title` | string | no | maxLength: 160 |
| `items` | array<object> | yes |  |

Example props generated from this schema:

```json
{
  "title": "example-title",
  "items": [
    {
      "term": "example-term",
      "definition": "example-definition",
      "aliases": [
        "example-aliases"
      ],
      "fact_ids": [
        "00000000-0000-4000-8000-000000000000"
      ]
    }
  ]
}
```

Required props: items.

## Example

Example document IR (the block the renderer consumes):

```json
{
  "type": "glossary",
  "props": {
    "title": "example-title",
    "items": [
      {
        "term": "example-term",
        "definition": "example-definition",
        "aliases": [
          "example-aliases"
        ],
        "fact_ids": [
          "00000000-0000-4000-8000-000000000000"
        ]
      }
    ]
  }
}
```

Renderer HTML (entities decoded and wrapped for display):

```html
<section class="ds-block ds-glossary" data-component="glossary" aria-labelledby="b-title">
<h3 class="ds-block-title" id="b-title">example-title</h3>
<dl class="ds-terms">
<dt>
<dfn>example-term</dfn>
</dt>
<dd>example-definition</dd>
<dd>Also called: example-aliases.</dd>
</dl>
</section>
```

Preview (interface-only; the markup above is the same output):

The renderer resolves this component as a native block; the preview above is its real HTML output, and Markdown parity for native blocks is covered by the renderer test suite.

## Specification

Generated from `packages/contracts/component-specs/glossary.md`.

### Contract

Production props are normative in `../contracts/component-props/glossary.schema.json`. The corresponding `component-fixtures` manifest is only a minimal protocol fixture; use the production props schema when building the published package. The packaged artifact ships exactly its generated `component-package.json` manifest plus `props.schema.json` (the production props schema, copied byte-for-byte) and `spec.md` (this spec, copied byte-for-byte); it contains no executable payload, fallback implementation, Storybook, test suite, SSR harness or README. Rendering behavior and the acceptance cases below belong to the renderer and the repository tests, not to the package. Installation pins the package version and the digest of every shipped byte.

### Intended behavior

Search terms/aliases, stable anchors and reusable references.

### Failure and fallback

Conflicting definitions flag review.

### Current React behavior

The production glossary renders all terms, full definitions and aliases as an accessible definition list. Local search appears after hydration and matches visible text with Unicode normalization; fact identifiers remain metadata. Links use unique widget-scoped term anchors, stable during filtering and reordering of distinct terms. Exact API names are never replaced with aliases. Multiple definitions for the same exact term remain visible with a review notice. Server output retains all entries without requiring JavaScript. The static native renderer remains read-only; cross-page reference resolution and constrained agent-tool dispatch require host integration.

### Required acceptance cases

No synonym replaces exact API names. Also test empty data, loading, denied access, browser without JS, mobile 360px, keyboard navigation, dark mode and an explicit constrained agent tool call. The server independently authorizes capability requests; a package manifest cannot grant authority.

### Data and maintenance

Data bindings resolve from a specific publication/release vector and permitted fact/evidence graph. Configuration edits create versioned component patches. Update invalidation uses dependency IDs, never indiscriminate whole-page regeneration. Human-owned props survive automatic updates unless invalidated with an explicit conflict. Missing optional resources leave an honest inert/readable fallback, not a broken page or fake success.

### Cost and tools

Pure/local interaction must never invoke a model by accident. Any model, remote query or executor call must reserve approved budget before dispatch. Public visitors do not inherit owner resources. The component may call only named tools in its signed manifest with valid typed inputs. A cancelled job stops polling and closes resources. No component gets platform administration, raw credentials or an unlimited execution loop.

## Package manifest

Protocol fixture: `packages/contracts/component-fixtures/glossary.json`.

| Field | Value |
| --- | --- |
| Name | @docsloth/glossary |
| Version | 1.0.0 |
| Protocol | 1.x |
| License | Apache-2.0 |
| Runtime | react |
| Entry | dist/index.js |
| Recording policy | masked |
| Fallback | html, markdown, json |
| Network hosts | none |
| Production write | no |
| Max runtime seconds | 0 |
| Integrity | all zeros (protocol fixture placeholder) |

| Tool | Effect | Confirmation | Input |
| --- | --- | --- | --- |
| search | read | no | value |

## Sources

| Source | Path |
| --- | --- |
| Component page | https://registry.docsloth.dev/components/glossary.html |
| Markdown twin | https://registry.docsloth.dev/docs/glossary.md |
| LLM index | https://registry.docsloth.dev/llms.txt |
| Specification | packages/contracts/component-specs/glossary.md |
| Prop schema | packages/contracts/component-props/glossary.schema.json |
| Protocol fixture | packages/contracts/component-fixtures/glossary.json |
| Catalog | packages/contracts/component-catalog.json |


---

# download

Integrity-checked approved artifact download

| Field | Value |
| --- | --- |
| Trust class | connected |
| Implementation status | implemented_native |
| Renderer | native block |
| Key prop (production schema) | artifact_id |
| Key prop (protocol fixture) | artifactId |
| Tools | download |
| Package version | 1.0.0 |
| Package digest | sha256:f1a556413ebbbde3829eb8b1e88e2bf5d354bf7dfec13ee142f4a3c064d8a5ef |

## Install

```sh
docsloth component add @docsloth/download@1.0.0
```

Live package: sha256:f1a556413ebbbde3829eb8b1e88e2bf5d354bf7dfec13ee142f4a3c064d8a5ef with 2 file digest(s); the catalog entry is generated from the built package, not a placeholder.

## Props

The prop schema is normative in `packages/contracts/component-props/download.schema.json`.

| Prop | Type | Required | Constraints |
| --- | --- | --- | --- |
| `title` | string | no | maxLength: 160 |
| `artifact_id` | string | yes | format: uuid |
| `filename` | string | yes | maxLength: 160 |
| `sha256` | string | yes | pattern: ^[a-f0-9]{64}$ |
| `size_bytes` | integer | yes |  |
| `license_label` | string | yes |  |

Example props generated from this schema:

```json
{
  "title": "example-title",
  "artifact_id": "00000000-0000-4000-8000-000000000000",
  "filename": "example-filename",
  "sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "size_bytes": 1,
  "license_label": "example-license_label"
}
```

Required props: artifact_id, filename, sha256, size_bytes, license_label.

## Example

Example document IR (the block the renderer consumes):

```json
{
  "type": "download",
  "props": {
    "title": "example-title",
    "artifact_id": "00000000-0000-4000-8000-000000000000",
    "filename": "example-filename",
    "sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
    "size_bytes": 1,
    "license_label": "example-license_label"
  }
}
```

Renderer HTML (entities decoded and wrapped for display):

```html
<section class="ds-block ds-download" data-component="download" aria-labelledby="b-title">
<h3 class="ds-block-title" id="b-title">example-title</h3>
<dl class="ds-facts">
<div>
<dt>File</dt>
<dd>
<code>example-filename</code>
</dd>
</div>
<div>
<dt>Size</dt>
<dd>1 byte</dd>
</div>
<div>
<dt>SHA-256</dt>
<dd>
<code>aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa</code>
</dd>
</div>
<div>
<dt>License</dt>
<dd>example-license_label</dd>
</div>
</dl>
<p class="ds-live-note" role="note">Downloads are issued by the live documentation site after an entitlement check.</p>
</section>
```

Preview (interface-only; the markup above is the same output):

The renderer resolves this component as a native block; the preview above is its real HTML output, and Markdown parity for native blocks is covered by the renderer test suite.

## Specification

Generated from `packages/contracts/component-specs/download.md`.

### Contract

Production props are normative in `../contracts/component-props/download.schema.json`. The corresponding `component-fixtures` manifest is only a minimal protocol fixture; use the production props schema when building the published package. The packaged artifact ships exactly its generated `component-package.json` manifest plus `props.schema.json` (the production props schema, copied byte-for-byte) and `spec.md` (this spec, copied byte-for-byte); it contains no executable payload, fallback implementation, Storybook, test suite, SSR harness or README. Rendering behavior and the acceptance cases below belong to the renderer and the repository tests, not to the package. Installation pins the package version and the digest of every shipped byte.

### Intended behavior

The React component uses production `artifact_id`, `filename`, `sha256`, `size_bytes` and `license_label`. A release-scoped `ComponentContentProvider.downloads` map supplies the host-issued binding for that artifact: `access: available`, `href`, `filename`, `sha256` and `size_bytes`. Only an exact metadata match produces a native download link. Destinations must be root-relative paths on the publication origin; external, credential-bearing and script URLs refuse. Filenames must be bounded basenames without controls or bidirectional override characters. Native links work without JavaScript and supply a filename hint with no referrer. No execution endpoint, model, clipboard or implicit capability request is invoked.

### Failure and fallback

`restricted`, `expired` and `revoked` bindings hide artifact details and provide no link; `loading` states that delivery is being prepared. Missing, invalid or mismatched bindings show unavailable delivery with the valid expected artifact metadata. The hash is explicitly labeled expected, not client-verified. The delivery server must independently validate the signed grant, current entitlement, response byte bounds/hash and Content-Disposition filename. The component cannot infer revocation from an opaque URL, inspect response bytes through native navigation, or prevent a server-side redirect; the host owns those guarantees. Hosts replace immutable bindings when access/release changes. Engine/cloud grant issuance and artifact delivery remain integration work; browser tests use an explicitly routed fixture and verify its actual downloaded bytes.

### Required acceptance cases

No open redirect or content-disposition filename injection. Also test empty data, loading, denied access, browser without JS, mobile 360px, keyboard navigation, dark mode and an explicit constrained agent tool call. The server independently authorizes capability requests; a package manifest cannot grant authority.

### Data and maintenance

Data bindings resolve from a specific publication/release vector and permitted fact/evidence graph. Configuration edits create versioned component patches. Update invalidation uses dependency IDs, never indiscriminate whole-page regeneration. Human-owned props survive automatic updates unless invalidated with an explicit conflict. Missing optional resources leave an honest inert/readable fallback, not a broken page or fake success.

### Cost and tools

Pure/local interaction must never invoke a model by accident. Any model, remote query or executor call must reserve approved budget before dispatch. Public visitors do not inherit owner resources. The component may call only named tools in its signed manifest with valid typed inputs. A cancelled job stops polling and closes resources. No component gets platform administration, raw credentials or an unlimited execution loop.

## Package manifest

Protocol fixture: `packages/contracts/component-fixtures/download.json`.

| Field | Value |
| --- | --- |
| Name | @docsloth/download |
| Version | 1.0.0 |
| Protocol | 1.x |
| License | Apache-2.0 |
| Runtime | react |
| Entry | dist/index.js |
| Recording policy | blocked |
| Fallback | html, markdown, json |
| Network hosts | none |
| Production write | no |
| Max runtime seconds | 120 |
| Integrity | all zeros (protocol fixture placeholder) |

| Tool | Effect | Confirmation | Input |
| --- | --- | --- | --- |
| download | read | no | value |

## Sources

| Source | Path |
| --- | --- |
| Component page | https://registry.docsloth.dev/components/download.html |
| Markdown twin | https://registry.docsloth.dev/docs/download.md |
| LLM index | https://registry.docsloth.dev/llms.txt |
| Specification | packages/contracts/component-specs/download.md |
| Prop schema | packages/contracts/component-props/download.schema.json |
| Protocol fixture | packages/contracts/component-fixtures/download.json |
| Catalog | packages/contracts/component-catalog.json |


---

# pricing-reference

Owner-sourced product prices; never inferred from code

| Field | Value |
| --- | --- |
| Trust class | pure |
| Implementation status | implemented_native |
| Renderer | native block |
| Key prop (production schema) | source_url |
| Key prop (protocol fixture) | sourceId |
| Tools | none |
| Package version | 1.0.0 |
| Package digest | sha256:ae1e3fa052f90eca94bd957b2aaea005b4eddf04b7a9f32e239f93101c71a118 |

## Install

```sh
docsloth component add @docsloth/pricing-reference@1.0.0
```

Live package: sha256:ae1e3fa052f90eca94bd957b2aaea005b4eddf04b7a9f32e239f93101c71a118 with 2 file digest(s); the catalog entry is generated from the built package, not a placeholder.

## Props

The prop schema is normative in `packages/contracts/component-props/pricing-reference.schema.json`.

| Prop | Type | Required | Constraints |
| --- | --- | --- | --- |
| `title` | string | no | maxLength: 160 |
| `source_url` | string | yes | format: uri |
| `verified_at` | string | yes | format: date-time |
| `currency` | string | yes |  |
| `rows` | array<object> | yes |  |
| `disclaimer` | string | yes |  |

Example props generated from this schema:

```json
{
  "title": "example-title",
  "source_url": "https://example.com/source-url",
  "verified_at": "2026-09-18T00:00:00Z",
  "currency": "example-currency",
  "rows": [
    {
      "key": "example-key",
      "cells": [
        "example-cells"
      ]
    }
  ],
  "disclaimer": "example-disclaimer"
}
```

Required props: source_url, verified_at, currency, rows, disclaimer.

## Example

Example document IR (the block the renderer consumes):

```json
{
  "type": "pricing-reference",
  "props": {
    "title": "example-title",
    "source_url": "https://example.com/source-url",
    "verified_at": "2026-09-18T00:00:00Z",
    "currency": "example-currency",
    "rows": [
      {
        "key": "example-key",
        "cells": [
          "example-cells"
        ]
      }
    ],
    "disclaimer": "example-disclaimer"
  }
}
```

Renderer HTML (entities decoded and wrapped for display):

```html
<section class="ds-block ds-pricing-reference" data-component="pricing-reference" aria-labelledby="b-title">
<h3 class="ds-block-title" id="b-title">example-title</h3>
<table class="ds-table">
<caption>Prices in example-currency</caption>
<thead>
<tr>
<th scope="col">Item</th>
<th scope="col">Price (example-currency)</th>
</tr>
</thead>
<tbody>
<tr>
<th scope="row">example-key</th>
<td>example-cells</td>
</tr>
</tbody>
</table>
<dl class="ds-facts">
<div>
<dt>Source</dt>
<dd>
<a href="https://example.com/source-url" rel="noopener noreferrer">https://example.com/source-url</a>
</dd>
</div>
<div>
<dt>Verified</dt>
<dd>
<time datetime="2026-09-18T00:00:00Z">2026-09-18T00:00:00Z</time>
</dd>
</div>
</dl>
<p>example-disclaimer</p>
</section>
```

Preview (interface-only; the markup above is the same output):

The renderer resolves this component as a native block; the preview above is its real HTML output, and Markdown parity for native blocks is covered by the renderer test suite.

## Specification

Generated from `packages/contracts/component-specs/pricing-reference.md`.

### Contract

Production props are normative in `../contracts/component-props/pricing-reference.schema.json`. The corresponding `component-fixtures` manifest is only a minimal protocol fixture; use the production props schema when building the published package. The packaged artifact ships exactly its generated `component-package.json` manifest plus `props.schema.json` (the production props schema, copied byte-for-byte) and `spec.md` (this spec, copied byte-for-byte); it contains no executable payload, fallback implementation, Storybook, test suite, SSR harness or README. Rendering behavior and the acceptance cases below belong to the renderer and the repository tests, not to the package. Installation pins the package version and the digest of every shipped byte.

### Intended behavior

Use owner-approved authoritative pricing, not code-inferred customer business promises.

### Failure and fallback

Outdated external price asks review; never automatically adopts unverified data.

### Required acceptance cases

Date/currency/tax terms visible and match approved source. Also test empty data, loading, denied access, browser without JS, mobile 360px, keyboard navigation, dark mode and an explicit constrained agent tool call. The server independently authorizes capability requests; a package manifest cannot grant authority.

### Data and maintenance

Data bindings resolve from a specific publication/release vector and permitted fact/evidence graph. Configuration edits create versioned component patches. Update invalidation uses dependency IDs, never indiscriminate whole-page regeneration. Human-owned props survive automatic updates unless invalidated with an explicit conflict. Missing optional resources leave an honest inert/readable fallback, not a broken page or fake success.

### Cost and tools

Pure/local interaction must never invoke a model by accident. Any model, remote query or executor call must reserve approved budget before dispatch. Public visitors do not inherit owner resources. The component may call only named tools in its signed manifest with valid typed inputs. A cancelled job stops polling and closes resources. No component gets platform administration, raw credentials or an unlimited execution loop.

## Package manifest

Protocol fixture: `packages/contracts/component-fixtures/pricing-reference.json`.

| Field | Value |
| --- | --- |
| Name | @docsloth/pricing-reference |
| Version | 1.0.0 |
| Protocol | 1.x |
| License | Apache-2.0 |
| Runtime | react |
| Entry | dist/index.js |
| Recording policy | masked |
| Fallback | html, markdown, json |
| Network hosts | none |
| Production write | no |
| Max runtime seconds | 0 |
| Integrity | all zeros (protocol fixture placeholder) |

## Sources

| Source | Path |
| --- | --- |
| Component page | https://registry.docsloth.dev/components/pricing-reference.html |
| Markdown twin | https://registry.docsloth.dev/docs/pricing-reference.md |
| LLM index | https://registry.docsloth.dev/llms.txt |
| Specification | packages/contracts/component-specs/pricing-reference.md |
| Prop schema | packages/contracts/component-props/pricing-reference.schema.json |
| Protocol fixture | packages/contracts/component-fixtures/pricing-reference.json |
| Catalog | packages/contracts/component-catalog.json |


---

# source-evidence

Expose audience-safe verification evidence

| Field | Value |
| --- | --- |
| Trust class | interactive |
| Implementation status | implemented_native |
| Renderer | native block |
| Key prop (production schema) | fact_id |
| Key prop (protocol fixture) | factId |
| Tools | inspect |
| Package version | 1.0.0 |
| Package digest | sha256:91585e02b9857ea171bd85a49520fd59109b6d4190ca3c4b2a521c28e0f7e972 |

## Install

```sh
docsloth component add @docsloth/source-evidence@1.0.0
```

Live package: sha256:91585e02b9857ea171bd85a49520fd59109b6d4190ca3c4b2a521c28e0f7e972 with 2 file digest(s); the catalog entry is generated from the built package, not a placeholder.

## Props

The prop schema is normative in `packages/contracts/component-props/source-evidence.schema.json`.

| Prop | Type | Required | Constraints |
| --- | --- | --- | --- |
| `title` | string | no | maxLength: 160 |
| `fact_id` | string | yes | format: uuid |
| `show_commit` | boolean | yes |  |
| `show_test_status` | boolean | yes |  |
| `allow_source_excerpt` | boolean | yes |  |

Example props generated from this schema:

```json
{
  "title": "example-title",
  "fact_id": "00000000-0000-4000-8000-000000000000",
  "show_commit": true,
  "show_test_status": true,
  "allow_source_excerpt": true
}
```

Required props: fact_id, show_commit, show_test_status, allow_source_excerpt.

## Example

Example document IR (the block the renderer consumes):

```json
{
  "type": "source-evidence",
  "props": {
    "title": "example-title",
    "fact_id": "00000000-0000-4000-8000-000000000000",
    "show_commit": true,
    "show_test_status": true,
    "allow_source_excerpt": true
  }
}
```

Renderer HTML (entities decoded and wrapped for display):

```html
<section class="ds-block ds-source-evidence" data-component="source-evidence" aria-labelledby="b-title">
<h3 class="ds-block-title" id="b-title">example-title</h3>
<dl class="ds-facts">
<div>
<dt>Shows</dt>
<dd>source commit, test status, source excerpt</dd>
</div>
</dl>
<p class="ds-live-note" role="note">Evidence is not available in this static view. The host must supply audience-permitted evidence for this fact.</p>
</section>
```

Preview (interface-only; the markup above is the same output):

The renderer resolves this component as a native block; the preview above is its real HTML output, and Markdown parity for native blocks is covered by the renderer test suite.

## Specification

Generated from `packages/contracts/component-specs/source-evidence.md`.

### Contract

Production props are normative in `../contracts/component-props/source-evidence.schema.json`. The corresponding `component-fixtures` manifest is only a minimal protocol fixture; use the production props schema when building the published package. The packaged artifact ships exactly its generated `component-package.json` manifest plus `props.schema.json` (the production props schema, copied byte-for-byte) and `spec.md` (this spec, copied byte-for-byte); it contains no executable payload, fallback implementation, Storybook, test suite, SSR harness or README. Rendering behavior and the acceptance cases below belong to the renderer and the repository tests, not to the package. Installation pins the package version and the digest of every shipped byte.

### Intended behavior

Show audience-permitted evidence and exact verification method/status.

### Failure and fallback

Private source returns public-safe evidence category only.

### Current React behavior

The component uses production `fact_id` to read the optional `evidence` map from `ComponentContentProvider` (`@docsloth/official-components/host`). Hosts supply only evidence already authorized for this audience and release. Available records contain a public category, optional summary, exact verification status/method, commit, excerpt and independently authorized source link. Restricted records contain only a public-safe category. Missing records are explicitly unavailable; `not_run`, failed, unsupported and unknown results never become verified. Display flags control commit, verification and excerpt presentation. They grant no access and do not make private fields safe to serialize to a browser. The host must omit unauthorized bytes. Complete escaped excerpts use native details/summary and remain usable without JavaScript; unsafe or credential-bearing links stay text-only. The static IR reports unavailable evidence instead of promising it exists elsewhere. This package does not fetch evidence, run verification, authorize source destinations or dispatch agent tools; those integrations remain host work.

### Required acceptance cases

Claim not_run never shown verified, link ACL independent. Also test empty data, loading, denied access, browser without JS, mobile 360px, keyboard navigation, dark mode and an explicit constrained agent tool call. The server independently authorizes capability requests; a package manifest cannot grant authority.

### Data and maintenance

Data bindings resolve from a specific publication/release vector and permitted fact/evidence graph. Configuration edits create versioned component patches. Update invalidation uses dependency IDs, never indiscriminate whole-page regeneration. Human-owned props survive automatic updates unless invalidated with an explicit conflict. Missing optional resources leave an honest inert/readable fallback, not a broken page or fake success.

### Cost and tools

Pure/local interaction must never invoke a model by accident. Any model, remote query or executor call must reserve approved budget before dispatch. Public visitors do not inherit owner resources. The component may call only named tools in its signed manifest with valid typed inputs. A cancelled job stops polling and closes resources. No component gets platform administration, raw credentials or an unlimited execution loop.

## Package manifest

Protocol fixture: `packages/contracts/component-fixtures/source-evidence.json`.

| Field | Value |
| --- | --- |
| Name | @docsloth/source-evidence |
| Version | 1.0.0 |
| Protocol | 1.x |
| License | Apache-2.0 |
| Runtime | react |
| Entry | dist/index.js |
| Recording policy | masked |
| Fallback | html, markdown, json |
| Network hosts | none |
| Production write | no |
| Max runtime seconds | 0 |
| Integrity | all zeros (protocol fixture placeholder) |

| Tool | Effect | Confirmation | Input |
| --- | --- | --- | --- |
| inspect | read | no | value |

## Sources

| Source | Path |
| --- | --- |
| Component page | https://registry.docsloth.dev/components/source-evidence.html |
| Markdown twin | https://registry.docsloth.dev/docs/source-evidence.md |
| LLM index | https://registry.docsloth.dev/llms.txt |
| Specification | packages/contracts/component-specs/source-evidence.md |
| Prop schema | packages/contracts/component-props/source-evidence.schema.json |
| Protocol fixture | packages/contracts/component-fixtures/source-evidence.json |
| Catalog | packages/contracts/component-catalog.json |


---

# steps

Ordered walkthrough steps

| Field | Value |
| --- | --- |
| Trust class | pure |
| Implementation status | implemented_native |
| Renderer | native block |
| Key prop (production schema) | title |
| Key prop (protocol fixture) | no protocol fixture published |
| Tools | none |
| Package version | 1.0.0 |
| Package digest | sha256:0ba6c7b14beefa4700152e0095a95ac319e7f7b4d9e87440d9bbba78710fab87 |

## Install

```sh
docsloth component add @docsloth/steps@1.0.0
```

Live package: sha256:0ba6c7b14beefa4700152e0095a95ac319e7f7b4d9e87440d9bbba78710fab87 with 2 file digest(s); the catalog entry is generated from the built package, not a placeholder.

## Props

The prop schema is normative in `packages/contracts/component-props/steps.schema.json`.

| Prop | Type | Required | Constraints |
| --- | --- | --- | --- |
| `title` | string | no | maxLength: 160 |

Example props generated from this schema:

```json
{
  "title": "Quickstart"
}
```

This schema requires no props beyond the component envelope.

## Example

Example document IR (the block the renderer consumes):

```json
{
  "type": "steps",
  "props": {
    "title": "Quickstart"
  },
  "children": [
    {
      "type": "prose",
      "props": {
        "label": "Install the CLI",
        "text": "Add the package."
      }
    },
    {
      "type": "prose",
      "props": {
        "label": "Render a page",
        "text": "Call renderPageToMarkdown."
      }
    }
  ]
}
```

Renderer HTML (entities decoded and wrapped for display):

```html
<ol class="ds-steps" data-component="steps" aria-label="Quickstart">
<li class="ds-step" data-step="1">
<span class="ds-step-number" aria-hidden="true" data-markdown-ignore="true">1</span>
<p class="ds-step-title">Install the CLI</p>
<div class="ds-prose">Add the package.</div>
</li>
<li class="ds-step" data-step="2">
<span class="ds-step-number" aria-hidden="true" data-markdown-ignore="true">2</span>
<p class="ds-step-title">Render a page</p>
<div class="ds-prose">Call renderPageToMarkdown.</div>
</li>
</ol>
```

Preview (interface-only; the markup above is the same output):

The renderer resolves this component as a native block; the preview above is its real HTML output, and Markdown parity for native blocks is covered by the renderer test suite.

## Specification

Generated from `packages/contracts/component-specs/steps.md`.

### Contract

Packaged: this block ships as `@docsloth/steps@1.0.0` — an installable component package (kind `block`, capability `render.html`, Apache-2.0) whose production props schema is `packages/contracts/component-props/steps.schema.json` and whose catalog entry is in `packages/contracts/component-catalog.json`. No protocol manifest fixture is published (`manifest_fixture: null`): the fixture models a packaged protocol runtime this block does not have.

### Intended behavior

Ordered walkthrough: each child renders as an `<li>` inside a single `<ol>`, with an optional step title from `label`/`title`/`summary`. Markdown emits a numbered list with the step body nested under its item, and JSON preserves child order and labels.

### Failure and fallback

Empty children or a non-array `children` value degrades to the labelled fallback block (`data-fallback="true"`, Markdown note, JSON `fallback: true`); an empty walkthrough never renders as silent success, and no prop shape throws.

### Required acceptance cases

Render two steps and assert `<ol>`/`<li>` order, `aria-hidden="true"` + `data-markdown-ignore="true"` on the number markers, `1.`/`2.` Markdown items, and HTML/Markdown visible-text parity. Also test empty data, a non-array children value, unknown extra props, mobile 360px, dark mode and an explicit constrained agent tool call. The server independently authorizes capability requests; a package manifest cannot grant authority.

### Data and maintenance

Data bindings resolve from a specific publication/release vector and permitted fact/evidence graph. Configuration edits create versioned component patches. Update invalidation uses dependency IDs, never indiscriminate whole-page regeneration. Human-owned props survive automatic updates unless invalidated with an explicit conflict. Missing optional resources leave an honest inert/readable fallback, not a broken page or fake success.

### Cost and tools

Pure/local interaction must never invoke a model by accident. Any model, remote query or executor call must reserve approved budget before dispatch. Public visitors do not inherit owner resources. The component may call only named tools in its signed manifest with valid typed inputs. A cancelled job stops polling and closes resources. No component gets platform administration, raw credentials or an unlimited execution loop.

### Native renderer block

Block type: `steps`. Renderer: `packages/renderer/src/index.ts` (native, no permission surface).

#### Native block props

| prop | type | required | behaviour |
| --- | --- | --- | --- |
| `title` | string | no | Accessible name for the `<ol>` (`aria-label`). |
| `children` | DocBlock[] | yes | One step per child. Child `label`/`title`/`summary` becomes the step title; the rest of the child renders as the step body. |
| `children[].props.label` | string | no | Step title. Omit for an untitled numbered step. |

Ordering comes from the `<ol>` and the Markdown list markers; the visible number badge is interface-only chrome marked `data-markdown-ignore` and `aria-hidden`.

#### Example

```json
{
  "type": "steps",
  "props": { "title": "Quickstart" },
  "children": [
    { "type": "prose", "props": { "label": "Install the CLI", "text": "Add the package." } },
    { "type": "prose", "props": { "label": "Render a page", "text": "Call renderPageToMarkdown." } }
  ]
}
```

Markdown:

```markdown
1. **Install the CLI**

   Add the package.

2. **Render a page**

   Call renderPageToMarkdown.
```

## Package manifest

No protocol fixture is published for this renderer-native block.

| Field | Value |
| --- | --- |
| Fixture | none published |

## Sources

| Source | Path |
| --- | --- |
| Component page | https://registry.docsloth.dev/components/steps.html |
| Markdown twin | https://registry.docsloth.dev/docs/steps.md |
| LLM index | https://registry.docsloth.dev/llms.txt |
| Specification | packages/contracts/component-specs/steps.md |
| Prop schema | packages/contracts/component-props/steps.schema.json |
| Catalog | packages/contracts/component-catalog.json |


---

# accordion

Progressive disclosure of optional detail

| Field | Value |
| --- | --- |
| Trust class | interactive |
| Implementation status | implemented_native |
| Renderer | native block |
| Key prop (production schema) | title |
| Key prop (protocol fixture) | no protocol fixture published |
| Tools | toggle |
| Package version | 1.0.0 |
| Package digest | sha256:320b0d6b28817df96a4f8b3274e151218c9f04c31862d4cd0d895397ee77258e |

## Install

```sh
docsloth component add @docsloth/accordion@1.0.0
```

Live package: sha256:320b0d6b28817df96a4f8b3274e151218c9f04c31862d4cd0d895397ee77258e with 2 file digest(s); the catalog entry is generated from the built package, not a placeholder.

## Props

The prop schema is normative in `packages/contracts/component-props/accordion.schema.json`.

| Prop | Type | Required | Constraints |
| --- | --- | --- | --- |
| `title` | string | no | maxLength: 160 |
| `open` | integer | no |  |

Example props generated from this schema:

```json
{
  "title": "FAQ",
  "open": 0
}
```

This schema requires no props beyond the component envelope.

## Example

Example document IR (the block the renderer consumes):

```json
{
  "type": "accordion",
  "props": {
    "title": "FAQ"
  },
  "children": [
    {
      "type": "prose",
      "props": {
        "label": "How is Markdown generated?",
        "text": "The same document IR drives HTML, Markdown and JSON."
      }
    }
  ]
}
```

Renderer HTML (entities decoded and wrapped for display):

```html
<div class="ds-accordion" data-component="accordion" aria-label="FAQ">
<details class="ds-accordion-item" open>
<summary class="ds-accordion-summary">
<span class="ds-accordion-marker" aria-hidden="true" data-markdown-ignore="true">▸</span>How is Markdown generated?</summary>
<div class="ds-prose">The same document IR drives HTML, Markdown and JSON.</div>
</details>
</div>
```

Preview (interface-only; the markup above is the same output):

The renderer resolves this component as a native block; the preview above is its real HTML output, and Markdown parity for native blocks is covered by the renderer test suite.

## Specification

Generated from `packages/contracts/component-specs/accordion.md`.

### Contract

Packaged: this block ships as `@docsloth/accordion@1.0.0` — an installable component package (kind `block`, capability `render.html`, Apache-2.0) whose production props schema is `packages/contracts/component-props/accordion.schema.json` and whose catalog entry is in `packages/contracts/component-catalog.json`. No protocol manifest fixture is published (`manifest_fixture: null`): the fixture models a packaged protocol runtime this block does not have.

### Intended behavior

Progressive disclosure built on `<details>`/`<summary>`: every child becomes an item whose `label`/`title`/`summary` is the summary text. All panel content stays in the HTML so no-JS and agent readers see it; Markdown flattens to titled `###` subsections with the content directly below.

### Failure and fallback

A child without a label/summary degrades the whole block to the labelled fallback block rather than rendering an unlabelled disclosure; empty children and non-array `children` values do the same. No prop shape throws.

### Required acceptance cases

Assert `details`/`summary` semantics, the first item open by default, the disclosure marker marked `data-markdown-ignore` + `aria-hidden`, `###` heading flattening in Markdown and HTML/Markdown visible-text parity. Also test empty data, a child without a summary, unknown extra props, browser without JS, mobile 360px, keyboard navigation, dark mode and an explicit constrained agent tool call. The server independently authorizes capability requests; a package manifest cannot grant authority.

### Data and maintenance

Data bindings resolve from a specific publication/release vector and permitted fact/evidence graph. Configuration edits create versioned component patches. Update invalidation uses dependency IDs, never indiscriminate whole-page regeneration. Human-owned props survive automatic updates unless invalidated with an explicit conflict. Missing optional resources leave an honest inert/readable fallback, not a broken page or fake success.

### Cost and tools

Pure/local interaction must never invoke a model by accident. Any model, remote query or executor call must reserve approved budget before dispatch. Public visitors do not inherit owner resources. The component may call only named tools in its signed manifest with valid typed inputs. A cancelled job stops polling and closes resources. No component gets platform administration, raw credentials or an unlimited execution loop.

### Native renderer block

Block type: `accordion`. Renderer: `packages/renderer/src/index.ts` (native, no permission surface).

#### Native block props

| prop | type | required | behaviour |
| --- | --- | --- | --- |
| `title` | string | no | Optional `aria-label` on the accordion container. |
| `open` | integer | no | Zero-based index of the item open by default (default `0`); out-of-range values simply leave the first item open. |
| `children` | DocBlock[] | yes | One disclosure per child; each child needs a non-empty `label`/`title`/`summary`. |
| `children[].props.open` | boolean | no | `true` forces that item open regardless of `open`. |

#### Example

```json
{
  "type": "accordion",
  "props": { "title": "FAQ" },
  "children": [
    {
      "type": "prose",
      "props": {
        "label": "How is Markdown generated?",
        "text": "The same document IR drives HTML, Markdown and JSON."
      }
    }
  ]
}
```

Markdown:

```markdown
### How is Markdown generated?

The same document IR drives HTML, Markdown and JSON.
```

## Package manifest

No protocol fixture is published for this renderer-native block.

| Field | Value |
| --- | --- |
| Fixture | none published |

## Sources

| Source | Path |
| --- | --- |
| Component page | https://registry.docsloth.dev/components/accordion.html |
| Markdown twin | https://registry.docsloth.dev/docs/accordion.md |
| LLM index | https://registry.docsloth.dev/llms.txt |
| Specification | packages/contracts/component-specs/accordion.md |
| Prop schema | packages/contracts/component-props/accordion.schema.json |
| Catalog | packages/contracts/component-catalog.json |


---

# badge

Compact status label

| Field | Value |
| --- | --- |
| Trust class | pure |
| Implementation status | implemented_native |
| Renderer | native block |
| Key prop (production schema) | text |
| Key prop (protocol fixture) | no protocol fixture published |
| Tools | none |
| Package version | 1.0.0 |
| Package digest | sha256:861bab9e5ab9cd4fcd541c879097947bc594509657e038e1129ae02381954717 |

## Install

```sh
docsloth component add @docsloth/badge@1.0.0
```

Live package: sha256:861bab9e5ab9cd4fcd541c879097947bc594509657e038e1129ae02381954717 with 2 file digest(s); the catalog entry is generated from the built package, not a placeholder.

## Props

The prop schema is normative in `packages/contracts/component-props/badge.schema.json`.

| Prop | Type | Required | Constraints |
| --- | --- | --- | --- |
| `text` | string \| number | no |  |
| `label` | string \| number | no | Alias for text. |
| `tone` | "info" \| "success" \| "warning" \| "danger" \| "neutral" | no |  |
| `prefix` | string | no | maxLength: 40 |

Example props generated from this schema:

```json
{
  "text": "Stable",
  "label": "Stable",
  "tone": "info",
  "prefix": "status"
}
```

This schema requires no props beyond the component envelope.

## Example

Example document IR (the block the renderer consumes):

```json
{
  "type": "badge",
  "props": {
    "text": "Stable",
    "tone": "success",
    "prefix": "status"
  }
}
```

Renderer HTML (entities decoded and wrapped for display):

```html
<span class="ds-badge" data-component="badge" data-tone="success">
<span class="ds-badge-prefix">status:</span> Stable</span>
```

Preview (interface-only; the markup above is the same output):

The renderer resolves this component as a native block; the preview above is its real HTML output, and Markdown parity for native blocks is covered by the renderer test suite.

## Specification

Generated from `packages/contracts/component-specs/badge.md`.

### Contract

Packaged: this block ships as `@docsloth/badge@1.0.0` — an installable component package (kind `block`, capability `render.html`, Apache-2.0) whose production props schema is `packages/contracts/component-props/badge.schema.json` and whose catalog entry is in `packages/contracts/component-catalog.json`. No protocol manifest fixture is published (`manifest_fixture: null`): the fixture models a packaged protocol runtime this block does not have.

### Intended behavior

Inline status pill: a `<span class="ds-badge">` carrying a tone and an optional textual prefix. Markdown renders the same message as inline code with the prefix inside it (`` `status: Stable` ``), so state survives copy/paste, diffs and agent extraction instead of relying on color alone. JSON keeps the raw props for machine consumers.

### Failure and fallback

Missing/empty `text` (or a non-string, non-finite-number value) degrades to the labelled fallback block. An unknown `tone` degrades to `info` without losing the message, and a non-string `prefix` falls back to the default `status` prefix. No prop shape throws.

### Required acceptance cases

Assert the tone whitelist (`info`, `success`, `warning`, `danger`, `neutral`), that prefix and text appear in both HTML and Markdown, that no live-region/`role="status"` semantics are claimed, and that HTML/Markdown visible text matches. Also test missing text, an unknown tone, unknown extra props, mobile 360px, dark mode and an explicit constrained agent tool call. The server independently authorizes capability requests; a package manifest cannot grant authority.

### Data and maintenance

Data bindings resolve from a specific publication/release vector and permitted fact/evidence graph. Configuration edits create versioned component patches. Update invalidation uses dependency IDs, never indiscriminate whole-page regeneration. Human-owned props survive automatic updates unless invalidated with an explicit conflict. Missing optional resources leave an honest inert/readable fallback, not a broken page or fake success.

### Cost and tools

Pure/local interaction must never invoke a model by accident. Any model, remote query or executor call must reserve approved budget before dispatch. Public visitors do not inherit owner resources. The component may call only named tools in its signed manifest with valid typed inputs. A cancelled job stops polling and closes resources. No component gets platform administration, raw credentials or an unlimited execution loop.

### Native renderer block

Block type: `badge`. Renderer: `packages/renderer/src/index.ts` (native, no permission surface).

#### Native block props

| prop | type | required | behaviour |
| --- | --- | --- | --- |
| `text` | string \| number | yes | Badge message; `label` is accepted as an alias. |
| `tone` | `info` \| `success` \| `warning` \| `danger` \| `neutral` | no | Visual tone (default `info`); unknown values degrade to `info`. |
| `prefix` | string | no | Textual prefix before the message (default `status`); an empty string omits it. |

#### Example

```json
{ "type": "badge", "props": { "text": "Stable", "tone": "success", "prefix": "status" } }
```

Markdown: `` `status: Stable` ``.

## Package manifest

No protocol fixture is published for this renderer-native block.

| Field | Value |
| --- | --- |
| Fixture | none published |

## Sources

| Source | Path |
| --- | --- |
| Component page | https://registry.docsloth.dev/components/badge.html |
| Markdown twin | https://registry.docsloth.dev/docs/badge.md |
| LLM index | https://registry.docsloth.dev/llms.txt |
| Specification | packages/contracts/component-specs/badge.md |
| Prop schema | packages/contracts/component-props/badge.schema.json |
| Catalog | packages/contracts/component-catalog.json |


---

# kbd

Keyboard shortcut chord

| Field | Value |
| --- | --- |
| Trust class | pure |
| Implementation status | implemented_native |
| Renderer | native block |
| Key prop (production schema) | keys |
| Key prop (protocol fixture) | no protocol fixture published |
| Tools | none |
| Package version | 1.0.0 |
| Package digest | sha256:e8a75f9817fa29cbf8e308381c4563f74c74fbbb87c27ab99b98af053bcac83f |

## Install

```sh
docsloth component add @docsloth/kbd@1.0.0
```

Live package: sha256:e8a75f9817fa29cbf8e308381c4563f74c74fbbb87c27ab99b98af053bcac83f with 2 file digest(s); the catalog entry is generated from the built package, not a placeholder.

## Props

The prop schema is normative in `packages/contracts/component-props/kbd.schema.json`.

| Prop | Type | Required | Constraints |
| --- | --- | --- | --- |
| `keys` | string \| array<string> | no | A shortcut chord; an array is joined with "+". |
| `text` | string | no | Alias for keys.; maxLength: 64 |

Example props generated from this schema:

```json
{
  "keys": [
    "Ctrl",
    "K"
  ],
  "text": "example-text"
}
```

This schema requires no props beyond the component envelope.

## Example

Example document IR (the block the renderer consumes):

```json
{
  "type": "kbd",
  "props": {
    "keys": [
      "Ctrl",
      "K"
    ]
  }
}
```

Renderer HTML (entities decoded and wrapped for display):

```html
<kbd class="ds-kbd" data-component="kbd">Ctrl+K</kbd>
```

Preview (interface-only; the markup above is the same output):

The renderer resolves this component as a native block; the preview above is its real HTML output, and Markdown parity for native blocks is covered by the renderer test suite.

## Specification

Generated from `packages/contracts/component-specs/kbd.md`.

### Contract

Packaged: this block ships as `@docsloth/kbd@1.0.0` — an installable component package (kind `block`, capability `render.html`, Apache-2.0) whose production props schema is `packages/contracts/component-props/kbd.schema.json` and whose catalog entry is in `packages/contracts/component-catalog.json`. No protocol manifest fixture is published (`manifest_fixture: null`): the fixture models a packaged protocol runtime this block does not have.

### Intended behavior

Keyboard shortcut: renders a semantic `<kbd>` element whose text is the chord. `keys` accepts a string (`"Ctrl+K"`) or an array of keys joined with `+` (`["Ctrl","K"]`). Markdown renders the same chord in backticks (`` `Ctrl+K` ``), and JSON keeps the raw props.

### Failure and fallback

Missing keys, an empty key array, or non-string entries in the array degrade to the labelled fallback block instead of rendering an empty or half-rendered key cap. No prop shape throws.

### Required acceptance cases

Assert `<kbd>` semantics, `+` joining for key arrays, backtick Markdown, escaping of hostile key text, and HTML/Markdown visible-text parity. Also test a missing `keys` prop, an empty array, unknown extra props, mobile 360px, dark mode and an explicit constrained agent tool call. The server independently authorizes capability requests; a package manifest cannot grant authority.

### Data and maintenance

Data bindings resolve from a specific publication/release vector and permitted fact/evidence graph. Configuration edits create versioned component patches. Update invalidation uses dependency IDs, never indiscriminate whole-page regeneration. Human-owned props survive automatic updates unless invalidated with an explicit conflict. Missing optional resources leave an honest inert/readable fallback, not a broken page or fake success.

### Cost and tools

Pure/local interaction must never invoke a model by accident. Any model, remote query or executor call must reserve approved budget before dispatch. Public visitors do not inherit owner resources. The component may call only named tools in its signed manifest with valid typed inputs. A cancelled job stops polling and closes resources. No component gets platform administration, raw credentials or an unlimited execution loop.

### Native renderer block

Block type: `kbd`. Renderer: `packages/renderer/src/index.ts` (native, no permission surface).

#### Native block props

| prop | type | required | behaviour |
| --- | --- | --- | --- |
| `keys` | string \| string[] | yes | Shortcut chord; an array is joined with `+`. `text` is accepted as an alias. |
| `text` | string | conditional | Alias for `keys` when `keys` is absent. |

#### Example

```json
{ "type": "kbd", "props": { "keys": ["Ctrl", "K"] } }
```

HTML: `<kbd class="ds-kbd">Ctrl+K</kbd>`. Markdown: `` `Ctrl+K` ``.

## Package manifest

No protocol fixture is published for this renderer-native block.

| Field | Value |
| --- | --- |
| Fixture | none published |

## Sources

| Source | Path |
| --- | --- |
| Component page | https://registry.docsloth.dev/components/kbd.html |
| Markdown twin | https://registry.docsloth.dev/docs/kbd.md |
| LLM index | https://registry.docsloth.dev/llms.txt |
| Specification | packages/contracts/component-specs/kbd.md |
| Prop schema | packages/contracts/component-props/kbd.schema.json |
| Catalog | packages/contracts/component-catalog.json |


---

# api-playground

Describe an API request without executing it

| Field | Value |
| --- | --- |
| Trust class | interactive |
| Implementation status | implemented_native |
| Renderer | native block |
| Key prop (production schema) | method |
| Key prop (protocol fixture) | no protocol fixture published |
| Tools | none |
| Package version | 1.0.0 |
| Package digest | sha256:e32a8142a4770416496adb7e57a0f590b6c89bfb7f78bd6726b96295478a2e4e |

## Install

```sh
docsloth component add @docsloth/api-playground@1.0.0
```

Live package: sha256:e32a8142a4770416496adb7e57a0f590b6c89bfb7f78bd6726b96295478a2e4e with 2 file digest(s); the catalog entry is generated from the built package, not a placeholder.

## Props

The prop schema is normative in `packages/contracts/component-props/api-playground.schema.json`.

| Prop | Type | Required | Constraints |
| --- | --- | --- | --- |
| `method` | string | yes | maxLength: 32; pattern: ^[A-Za-z][A-Za-z0-9-]*$ |
| `path` | string | yes | maxLength: 500 |
| `baseUrl` | string | no | maxLength: 500; pattern: ^https?:// |
| `auth` | "none" \| "bearer" | no |  |
| `parameters` | array<object> | no |  |
| `requestBody` | object | no | additionalProperties: false |
| `requestBody.contentType` | string | no | maxLength: 200 |
| `requestBody.example` | string | no |  |
| `summary` | string | no | maxLength: 500 |

Example props generated from this schema:

```json
{
  "method": "GET",
  "path": "/v1/pets",
  "baseUrl": "https://api.example.com",
  "auth": "none",
  "parameters": [
    {
      "name": "limit",
      "in": "query",
      "required": true,
      "description": "Max items",
      "example": 10
    }
  ],
  "requestBody": {
    "contentType": "application/json",
    "example": "{\"name\":\"Rex\"}"
  },
  "summary": "Create a pet"
}
```

Required props: method, path.

## Example

Example document IR (the block the renderer consumes):

```json
{
  "type": "api-playground",
  "props": {
    "method": "POST",
    "path": "/v1/pets",
    "baseUrl": "https://api.example.com",
    "auth": "bearer",
    "summary": "Create a pet",
    "parameters": [
      {
        "name": "limit",
        "in": "query",
        "required": false,
        "description": "Max items",
        "example": 10
      }
    ],
    "requestBody": {
      "contentType": "application/json",
      "example": "{\"name\":\"Rex\"}"
    }
  }
}
```

Renderer HTML (entities decoded and wrapped for display):

```html
<section class="ds-playground" data-component="api-playground" data-method="POST" data-auth="bearer" aria-label="POST /v1/pets API playground">
<p class="ds-playground-summary">Create a pet</p>
<p class="ds-playground-signature">
<span class="ds-method" data-method="POST">POST</span>
<code class="ds-playground-path">/v1/pets</code>
</p>
<pre class="ds-playground-example" aria-label="Example request">
<code>POST https://api.example.com/v1/pets?limit=10
Authorization: Bearer <token>
Content-Type: application/json

{"name":"Rex"}</code>
</pre>
<form class="ds-playground-form" data-ds-playground-form data-markdown-ignore="true" aria-label="Request builder">
<fieldset class="ds-playground-fields">
<legend>Parameters</legend>
<div class="ds-playground-field">
<label for="b-param-0">limit (query)</label>
<input id="b-param-0" name="limit" type="text" value="10" aria-describedby="b-param-0-hint">
<p class="ds-playground-hint" id="b-param-0-hint">Max items</p>
</div>
</fieldset>
<fieldset class="ds-playground-fields">
<legend>Request body (application/json)</legend>
<label for="b-body">Body (application/json)</label>
<textarea id="b-body" name="body" rows="4">{"name":"Rex"}</textarea>
</fieldset>
<button type="submit" class="ds-playground-run" data-ds-playground aria-label="Run request">Run</button>
</form>
<table class="ds-playground-params">
<thead>
<tr>
<th>name</th>
<th>in</th>
<th>required</th>
<th>description</th>
<th>example</th>
</tr>
</thead>
<tbody>
<tr>
<td>limit</td>
<td>query</td>
<td>no</td>
<td>Max items</td>
<td>10</td>
</tr>
</tbody>
</table>
<p class="ds-playground-note">Requests run in the host page. Nothing executes in the renderer.</p>
</section>
```

Preview (interface-only; the markup above is the same output):

The renderer resolves this component as a native block; the preview above is its real HTML output, and Markdown parity for native blocks is covered by the renderer test suite.

## Specification

Generated from `packages/contracts/component-specs/api-playground.md`.

### Contract

Packaged: this block ships as `@docsloth/api-playground@1.0.0` — an installable component package (kind `block`, capability `render.html`, Apache-2.0) whose production props schema is `packages/contracts/component-props/api-playground.schema.json` and whose catalog entry is in `packages/contracts/component-catalog.json`. No protocol manifest fixture is published (`manifest_fixture: null`): the fixture models a packaged protocol runtime this block does not have.

### Intended behavior

Build a request from an OpenAPI-style operation: method, path, optional base URL, auth mode, typed parameters and an optional request body. The example request line and parameter table are generated server-side from props, so the same request exists as inert HTML text and as an agent-readable `http` fence. The form is progressive enhancement only.

### Failure and fallback

A missing or invalid `method`/`path`, a non-array `parameters`, a parameter without a name, or a non-object `requestBody` degrades the whole block to the labelled fallback. An unknown `auth` value and a non-`http(s)` `baseUrl` degrade in place (ignored) instead of taking out the block.

### Required acceptance cases

Opening the page, reading the Markdown twin or submitting the form must never perform a network request, read a credential or execute renderer-supplied code without a host-provided handler. Also test empty data, missing parameters, a `bearer` example, browser without JS, mobile 360px, keyboard navigation, dark mode and an explicit constrained agent tool call. The server independently authorizes capability requests; a package manifest cannot grant authority.

### Data and maintenance

Data bindings resolve from a specific publication/release vector and permitted fact/evidence graph. Configuration edits create versioned component patches. Update invalidation uses dependency IDs, never indiscriminate whole-page regeneration. Human-owned props survive automatic updates unless invalidated with an explicit conflict. Missing optional resources leave an honest inert/readable fallback, not a broken page or fake success.

### Cost and tools

Pure/local interaction must never invoke a model by accident. Running a request is a host capability: the renderer emits no script, no inline handler and no `action`, and it never receives raw credentials. Any model, remote query or executor call must reserve approved budget before dispatch. The component may call only named tools in its signed manifest with valid typed inputs.

### Native renderer block

`packages/renderer` renders an `api-playground` block from the document IR. HTML emits an accessible `<form>` (`data-ds-playground-form`) whose inputs are `<label for=…>`-wired and described by their hints, a Run button carrying `data-ds-playground`, a server-side example request line and a parameter table. Markdown emits the same request as a fenced `http` example plus the same parameter table — the agent fallback — and repeats the progressive-enhancement note. Running requests is the host page's responsibility; nothing executes in the renderer.

#### Native block props

| prop | type | required | behaviour |
| --- | --- | --- | --- |
| `method` | string | yes | HTTP method token, normalised to upper case; missing or non-token values degrade to the fallback. |
| `path` | string | yes | Path (a missing leading `/` is added) or absolute URL; whitespace, quotes and angle brackets degrade to the fallback. |
| `baseUrl` | string | no | `http(s)` origin prefixed to the example URL; any other value is ignored. |
| `auth` | `'none' \| 'bearer'` | no | `bearer` adds an `Authorization: Bearer <token>` line to the example; any other value is ignored. |
| `parameters` | `{name, in, required?, description?, example?}[]` | no | One labelled input plus one table row per parameter; a wrong shape degrades to the fallback. |
| `requestBody` | `{contentType, example?}` | no | Adds a `Content-Type` line and body text; a wrong shape degrades to the fallback. |
| `summary` | string | no | Visible description of the operation, mirrored in Markdown. |

The form is interface-only chrome and is marked `data-markdown-ignore`; because hiding a focusable control would break assistive technology it stays in the accessibility tree. The parameter table, example request and note are content and are never ignored.

#### Example

```json
{
  "type": "api-playground",
  "props": {
    "method": "POST",
    "path": "/v1/pets",
    "baseUrl": "https://api.example.com",
    "auth": "bearer",
    "summary": "Create a pet",
    "parameters": [
      { "name": "limit", "in": "query", "required": false, "description": "Max items", "example": 10 }
    ],
    "requestBody": { "contentType": "application/json", "example": "{\"name\":\"Rex\"}" }
  }
}
```

## Package manifest

No protocol fixture is published for this renderer-native block.

| Field | Value |
| --- | --- |
| Fixture | none published |

## Sources

| Source | Path |
| --- | --- |
| Component page | https://registry.docsloth.dev/components/api-playground.html |
| Markdown twin | https://registry.docsloth.dev/docs/api-playground.md |
| LLM index | https://registry.docsloth.dev/llms.txt |
| Specification | packages/contracts/component-specs/api-playground.md |
| Prop schema | packages/contracts/component-props/api-playground.schema.json |
| Catalog | packages/contracts/component-catalog.json |


---

# openapi-operation

Static OpenAPI operation reference

| Field | Value |
| --- | --- |
| Trust class | pure |
| Implementation status | implemented_native |
| Renderer | native block |
| Key prop (production schema) | operationId |
| Key prop (protocol fixture) | no protocol fixture published |
| Tools | none |
| Package version | 1.0.0 |
| Package digest | sha256:0d07bbe12d9741605cc6552c81ff01c845a98de7aaec18b91aa912e1728ec559 |

## Install

```sh
docsloth component add @docsloth/openapi-operation@1.0.0
```

Live package: sha256:0d07bbe12d9741605cc6552c81ff01c845a98de7aaec18b91aa912e1728ec559 with 2 file digest(s); the catalog entry is generated from the built package, not a placeholder.

## Props

The prop schema is normative in `packages/contracts/component-props/openapi-operation.schema.json`.

| Prop | Type | Required | Constraints |
| --- | --- | --- | --- |
| `operationId` | string | yes | maxLength: 200 |
| `method` | string | yes | maxLength: 32; pattern: ^[A-Za-z][A-Za-z0-9-]*$ |
| `path` | string | yes | maxLength: 500 |
| `summary` | string | yes | maxLength: 500 |
| `parameters` | array<object> | no |  |
| `responses` | array<object> | no |  |

Example props generated from this schema:

```json
{
  "operationId": "getPet",
  "method": "GET",
  "path": "/v1/pets",
  "summary": "Retrieve a pet",
  "parameters": [
    {
      "name": "limit",
      "in": "query",
      "required": true,
      "description": "Max items",
      "example": 10
    }
  ],
  "responses": [
    {
      "status": 200,
      "description": "A pet"
    }
  ]
}
```

Required props: operationId, method, path, summary.

## Example

Example document IR (the block the renderer consumes):

```json
{
  "type": "openapi-operation",
  "props": {
    "operationId": "getPet",
    "method": "GET",
    "path": "/pets/{petId}",
    "summary": "Retrieve a pet",
    "parameters": [
      {
        "name": "petId",
        "in": "path",
        "required": true,
        "description": "Pet id",
        "example": "42"
      }
    ],
    "responses": [
      {
        "status": 200,
        "description": "A pet"
      },
      {
        "status": 404,
        "description": "Not found"
      }
    ]
  }
}
```

Renderer HTML (entities decoded and wrapped for display):

```html
<section class="ds-operation" data-component="openapi-operation" data-operation-id="getPet" aria-label="GET /pets/{petId} operation">
<p class="ds-operation-signature">
<span class="ds-method" data-method="GET">GET</span>
<code class="ds-operation-path">/pets/{petId}</code>
</p>
<p class="ds-operation-summary">Retrieve a pet</p>
<table class="ds-operation-params">
<thead>
<tr>
<th>name</th>
<th>in</th>
<th>required</th>
<th>description</th>
<th>example</th>
</tr>
</thead>
<tbody>
<tr>
<td>petId</td>
<td>path</td>
<td>yes</td>
<td>Pet id</td>
<td>42</td>
</tr>
</tbody>
</table>
<table class="ds-operation-responses">
<thead>
<tr>
<th>status</th>
<th>description</th>
</tr>
</thead>
<tbody>
<tr>
<td>200</td>
<td>A pet</td>
</tr>
<tr>
<td>404</td>
<td>Not found</td>
</tr>
</tbody>
</table>
<pre class="ds-operation-example" aria-label="Example request">
<code>GET /pets/{petId}</code>
</pre>
</section>
```

Preview (interface-only; the markup above is the same output):

The renderer resolves this component as a native block; the preview above is its real HTML output, and Markdown parity for native blocks is covered by the renderer test suite.

## Specification

Generated from `packages/contracts/component-specs/openapi-operation.md`.

### Contract

Packaged: this block ships as `@docsloth/openapi-operation@1.0.0` — an installable component package (kind `block`, capability `render.html`, Apache-2.0) whose production props schema is `packages/contracts/component-props/openapi-operation.schema.json` and whose catalog entry is in `packages/contracts/component-catalog.json`. No protocol manifest fixture is published (`manifest_fixture: null`): the fixture models a packaged protocol runtime this block does not have.

### Intended behavior

Render one static OpenAPI operation — the counterpart the core can generate from a spec — as a readable card: method badge, path, summary, parameter table and response table. Because it is props-driven it needs no network, spec fetch or schema resolution at render time, and the Markdown twin carries the same tables plus an `http` example so agents can reconstruct the operation without parsing HTML.

### Failure and fallback

A missing `operationId`/`summary`/`method`/`path`, a non-array `parameters`/`responses`, a parameter without a name or a response without a status degrades the block to the labelled fallback. An operation with no parameters or responses is valid and simply omits those tables. Unknown extra props are ignored.

### Required acceptance cases

Rendering the same operation twice must produce identical output (no clock, no random ids, no fetches), and the Markdown twin must name every parameter and response the HTML shows. Also test empty data, loading, denied access, browser without JS, mobile 360px, keyboard navigation, dark mode and an explicit constrained agent tool call. The server independently authorizes capability requests; a package manifest cannot grant authority.

### Data and maintenance

Data bindings resolve from a specific publication/release vector and permitted fact/evidence graph. Configuration edits create versioned component patches. Update invalidation uses dependency IDs, never indiscriminate whole-page regeneration. Human-owned props survive automatic updates unless invalidated with an explicit conflict. Missing optional resources leave an honest inert/readable fallback, not a broken page or fake success.

### Cost and tools

Pure/local interaction must never invoke a model by accident. Any model, remote query or executor call must reserve approved budget before dispatch. Public visitors do not inherit owner resources. The component may call only named tools in its signed manifest with valid typed inputs. A cancelled job stops polling and closes resources. No component gets platform administration, raw credentials or an unlimited execution loop.

### Native renderer block

`packages/renderer` renders an `openapi-operation` block as a `<section data-operation-id="…">` with a method badge (`data-method`), the path, the summary, a parameters table (`name`, `in`, `required`, `description`, `example`), a responses table (`status`, `description`) and an example request line. Markdown emits the same signature, summary and tables, then the same request as a fenced `http` example. All content is static and escaped; nothing is fetched or executed.

#### Native block props

| prop | type | required | behaviour |
| --- | --- | --- | --- |
| `operationId` | string | yes | Written to `data-operation-id` for host anchor/navigation use; empty values degrade to the fallback. |
| `method` | string | yes | HTTP method token, normalised to upper case and shown as a badge. |
| `path` | string | yes | Operation path; a missing leading `/` is added. Invalid characters degrade to the fallback. |
| `summary` | string | yes | Visible one-line description of the operation. |
| `parameters` | `{name, in, required?, description?, example?}[]` | no | Parameter table rows; wrong shape degrades to the fallback. |
| `responses` | `{status, description?}[]` | no | Response table rows; wrong shape or a row without a status degrades to the fallback. |

#### Example

```json
{
  "type": "openapi-operation",
  "props": {
    "operationId": "getPet",
    "method": "GET",
    "path": "/pets/{petId}",
    "summary": "Retrieve a pet",
    "parameters": [{ "name": "petId", "in": "path", "required": true, "description": "Pet id", "example": "42" }],
    "responses": [{ "status": 200, "description": "A pet" }, { "status": 404, "description": "Not found" }]
  }
}
```

## Package manifest

No protocol fixture is published for this renderer-native block.

| Field | Value |
| --- | --- |
| Fixture | none published |

## Sources

| Source | Path |
| --- | --- |
| Component page | https://registry.docsloth.dev/components/openapi-operation.html |
| Markdown twin | https://registry.docsloth.dev/docs/openapi-operation.md |
| LLM index | https://registry.docsloth.dev/llms.txt |
| Specification | packages/contracts/component-specs/openapi-operation.md |
| Prop schema | packages/contracts/component-props/openapi-operation.schema.json |
| Catalog | packages/contracts/component-catalog.json |


---

# mermaid

Mermaid diagram source kept readable for agents

| Field | Value |
| --- | --- |
| Trust class | interactive |
| Implementation status | implemented_native |
| Renderer | native block |
| Key prop (production schema) | code |
| Key prop (protocol fixture) | no protocol fixture published |
| Tools | copy |
| Package version | 1.0.0 |
| Package digest | sha256:96b5e8ca9f6f9073fe60f842a095787824b89447f9314189b83d5505133d7a88 |

## Install

```sh
docsloth component add @docsloth/mermaid@1.0.0
```

Live package: sha256:96b5e8ca9f6f9073fe60f842a095787824b89447f9314189b83d5505133d7a88 with 2 file digest(s); the catalog entry is generated from the built package, not a placeholder.

## Props

The prop schema is normative in `packages/contracts/component-props/mermaid.schema.json`.

| Prop | Type | Required | Constraints |
| --- | --- | --- | --- |
| `code` | string | yes | maxLength: 100000 |

Example props generated from this schema:

```json
{
  "code": "graph TD;\n  A[Start]-->B[Ship];"
}
```

Required props: code.

## Example

Example document IR (the block the renderer consumes):

```json
{
  "type": "mermaid",
  "props": {
    "code": "graph TD;\n  A[Start]-->B[Ship];"
  }
}
```

Renderer HTML (entities decoded and wrapped for display):

```html
<div class="ds-mermaid" data-component="mermaid">
<pre class="mermaid" data-ds-mermaid>graph TD;
  A[Start]-->B[Ship];</pre>
<button type="button" class="ds-mermaid-copy" data-ds-copy data-markdown-ignore="true" aria-label="Copy diagram source">Copy</button>
</div>
```

Preview (interface-only; the markup above is the same output):

The renderer resolves this component as a native block; the preview above is its real HTML output, and Markdown parity for native blocks is covered by the renderer test suite.

## Specification

Generated from `packages/contracts/component-specs/mermaid.md`.

### Contract

Packaged: this block ships as `@docsloth/mermaid@1.0.0` — an installable component package (kind `block`, capability `render.html`, Apache-2.0) whose production props schema is `packages/contracts/component-props/mermaid.schema.json` and whose catalog entry is in `packages/contracts/component-catalog.json`. No protocol manifest fixture is published (`manifest_fixture: null`): the fixture models a packaged protocol runtime this block does not have.

### Intended behavior

Pass diagram source through unchanged so a host-configured Mermaid renderer can draw it, while every reader still sees the source. HTML emits an inert `<pre class="mermaid" data-ds-mermaid>` whose text is the escaped source, plus a copy control. Markdown always emits the fenced `mermaid` code block, so agents never lose the diagram.

### Failure and fallback

A missing or non-string `code` prop degrades the block to the labelled fallback. Hostile source is escaped in HTML and never becomes markup; a fenced copy survives verbatim in Markdown because fences are data, not page structure.

### Required acceptance cases

No diagram renderer, network call or model call may run from the renderer; until a host renders it, the block must remain readable source. Source containing backticks or HTML must not break out of the fence or the `<pre>`. Also test empty data, loading, denied access, browser without JS, mobile 360px, keyboard navigation, dark mode and an explicit constrained agent tool call. The server independently authorizes capability requests; a package manifest cannot grant authority.

### Data and maintenance

Data bindings resolve from a specific publication/release vector and permitted fact/evidence graph. Configuration edits create versioned component patches. Update invalidation uses dependency IDs, never indiscriminate whole-page regeneration. Human-owned props survive automatic updates unless invalidated with an explicit conflict. Missing optional resources leave an honest inert/readable fallback, not a broken page or fake success.

### Cost and tools

Pure/local interaction must never invoke a model by accident. Any model, remote query or executor call must reserve approved budget before dispatch. Public visitors do not inherit owner resources. The component may call only named tools in its signed manifest with valid typed inputs. A cancelled job stops polling and closes resources. No component gets platform administration, raw credentials or an unlimited execution loop.

### Native renderer block

`packages/renderer` renders a `mermaid` block from the document IR. HTML emits `<pre class="mermaid" data-ds-mermaid>` containing the escaped source and a copy button (`data-ds-copy`); the copy button is the only element marked `data-markdown-ignore`, and it stays in the accessibility tree because it is an interactive control. Markdown emits the fenced `mermaid` code block (fence length grown to survive backticks in the source) so agents always get the source.

#### Native block props

| prop | type | required | behaviour |
| --- | --- | --- | --- |
| `code` | string | yes | Mermaid diagram source. Non-empty strings render; anything else degrades the block to the labelled fallback. |

#### Example

```json
{
  "type": "mermaid",
  "props": { "code": "graph TD;\n  A[Start]-->B[Ship];" }
}
```

## Package manifest

No protocol fixture is published for this renderer-native block.

| Field | Value |
| --- | --- |
| Fixture | none published |

## Sources

| Source | Path |
| --- | --- |
| Component page | https://registry.docsloth.dev/components/mermaid.html |
| Markdown twin | https://registry.docsloth.dev/docs/mermaid.md |
| LLM index | https://registry.docsloth.dev/llms.txt |
| Specification | packages/contracts/component-specs/mermaid.md |
| Prop schema | packages/contracts/component-props/mermaid.schema.json |
| Catalog | packages/contracts/component-catalog.json |


---

# code-group

Labelled alternative code samples

| Field | Value |
| --- | --- |
| Trust class | interactive |
| Implementation status | implemented_native |
| Renderer | native block |
| Key prop (production schema) | title |
| Key prop (protocol fixture) | no protocol fixture published |
| Tools | select_tab |
| Package version | 1.0.0 |
| Package digest | sha256:eb5f37eae33a615a71ec7d4f1b84f436655eb8f4020762901bf67e80a0c8b5e8 |

## Install

```sh
docsloth component add @docsloth/code-group@1.0.0
```

Live package: sha256:eb5f37eae33a615a71ec7d4f1b84f436655eb8f4020762901bf67e80a0c8b5e8 with 2 file digest(s); the catalog entry is generated from the built package, not a placeholder.

## Props

The prop schema is normative in `packages/contracts/component-props/code-group.schema.json`.

| Prop | Type | Required | Constraints |
| --- | --- | --- | --- |
| `title` | string | no | maxLength: 160 |
| `active` | integer | no |  |
| `activeTab` | string | no | maxLength: 256 |

Example props generated from this schema:

```json
{
  "title": "Install",
  "active": 0,
  "activeTab": "npm"
}
```

This schema requires no props beyond the component envelope.

## Example

Example document IR (the block the renderer consumes):

```json
{
  "type": "code-group",
  "props": {
    "title": "Install",
    "active": 0
  },
  "children": [
    {
      "type": "code",
      "props": {
        "label": "npm",
        "language": "bash",
        "code": "npm add @docsloth/renderer"
      }
    },
    {
      "type": "code",
      "props": {
        "label": "pnpm",
        "language": "bash",
        "code": "pnpm add @docsloth/renderer"
      }
    }
  ]
}
```

Renderer HTML (entities decoded and wrapped for display):

```html
<div class="ds-code-group" data-component="code-group">
<div class="ds-tablist" role="tablist" aria-label="Install">
<button type="button" class="ds-tab" role="tab" id="b-tab-0" aria-controls="b-panel-0" aria-selected="true" tabindex="0">npm</button>
<button type="button" class="ds-tab" role="tab" id="b-tab-1" aria-controls="b-panel-1" aria-selected="false" tabindex="-1">pnpm</button>
</div>
<div class="ds-tabpanels">
<div class="ds-tabpanel" role="tabpanel" id="b-panel-0" aria-labelledby="b-tab-0" tabindex="0">
<pre class="ds-code" data-lang="bash">
<code>npm add @docsloth/renderer</code>
</pre>
</div>
<div class="ds-tabpanel" role="tabpanel" id="b-panel-1" aria-labelledby="b-tab-1" tabindex="0">
<pre class="ds-code" data-lang="bash">
<code>pnpm add @docsloth/renderer</code>
</pre>
</div>
</div>
</div>
```

Preview (interface-only; the markup above is the same output):

The renderer resolves this component as a native block; the preview above is its real HTML output, and Markdown parity for native blocks is covered by the renderer test suite.

## Specification

Generated from `packages/contracts/component-specs/code-group.md`.

### Contract

Packaged: this block ships as `@docsloth/code-group@1.0.0` — an installable component package (kind `block`, capability `render.html`, Apache-2.0) whose production props schema is `packages/contracts/component-props/code-group.schema.json` and whose catalog entry is in `packages/contracts/component-catalog.json`. No protocol manifest fixture is published (`manifest_fixture: null`): the fixture models a packaged protocol runtime this block does not have.

### Intended behavior

Group equivalent code samples (package managers, language variants, platform variants) without duplicating page content. Every sample stays in the DOM so no-JS and agent readers see all of them; the tablist only selects emphasis.

### Failure and fallback

A group with no children, a child without a non-empty `props.label`, or a child that is not a `code` block degrades the whole block to the labelled fallback while keeping the child content visible. Unknown `active`/`activeTab` values degrade in place to the first sample.

### Required acceptance cases

Switching samples must not change the meaning or content of any fence; the same language tag survives in the Markdown twin. Also test empty data, loading, denied access, browser without JS, mobile 360px, keyboard navigation, dark mode and an explicit constrained agent tool call. The server independently authorizes capability requests; a package manifest cannot grant authority.

### Data and maintenance

Data bindings resolve from a specific publication/release vector and permitted fact/evidence graph. Configuration edits create versioned component patches. Update invalidation uses dependency IDs, never indiscriminate whole-page regeneration. Human-owned props survive automatic updates unless invalidated with an explicit conflict. Missing optional resources leave an honest inert/readable fallback, not a broken page or fake success.

### Cost and tools

Pure/local interaction must never invoke a model by accident. Any model, remote query or executor call must reserve approved budget before dispatch. Public visitors do not inherit owner resources. The component may call only named tools in its signed manifest with valid typed inputs. A cancelled job stops polling and closes resources. No component gets platform administration, raw credentials or an unlimited execution loop.

### Native renderer block

`packages/renderer` renders a `code-group` block with the existing `tabs` a11y contract: a `role="tablist"` whose `role="tab"` buttons wire `aria-controls` to matching `role="tabpanel"` panels, with the accessible name from `props.title` (default `Code samples`). Panels stay in the DOM (no `hidden`), so every sample reaches no-JS and agent readers. Markdown flattens the block to `### <label>` subsections, each containing the child code fence with its original language tag.

#### Native block props

| prop | type | required | behaviour |
| --- | --- | --- | --- |
| `title` | string | no | Accessible name of the tablist (`aria-label`, default `Code samples`). |
| `active` | integer | no | Zero-based index selected by default; unknown values degrade to the first sample. |
| `activeTab` | string | no | Label or `props.id` of the selected sample; unknown ids degrade to the first sample. |
| `children` | `code[]` | yes | One sample per child; each child needs a non-empty `props.label` and `type: "code"`. A missing label or a non-code child degrades the whole block to the labelled fallback. |

The tab buttons are content labels, not chrome, so they are not marked `data-markdown-ignore`; the Markdown twin carries the same labels as headings and the same language tags as fence info strings.

#### Example

```json
{
  "type": "code-group",
  "props": { "title": "Install", "active": 0 },
  "children": [
    { "type": "code", "props": { "label": "npm", "language": "bash", "code": "npm add @docsloth/renderer" } },
    { "type": "code", "props": { "label": "pnpm", "language": "bash", "code": "pnpm add @docsloth/renderer" } }
  ]
}
```

## Package manifest

No protocol fixture is published for this renderer-native block.

| Field | Value |
| --- | --- |
| Fixture | none published |

## Sources

| Source | Path |
| --- | --- |
| Component page | https://registry.docsloth.dev/components/code-group.html |
| Markdown twin | https://registry.docsloth.dev/docs/code-group.md |
| LLM index | https://registry.docsloth.dev/llms.txt |
| Specification | packages/contracts/component-specs/code-group.md |
| Prop schema | packages/contracts/component-props/code-group.schema.json |
| Catalog | packages/contracts/component-catalog.json |


---

# versioned-content

Version-scoped content region

| Field | Value |
| --- | --- |
| Trust class | pure |
| Implementation status | implemented_native |
| Renderer | native block |
| Key prop (production schema) | version |
| Key prop (protocol fixture) | no protocol fixture published |
| Tools | none |
| Package version | 1.0.0 |
| Package digest | sha256:1e23f883a5debc8a859214dc206755936b9b9541f764618c5c1c7aea4ac88d9c |

## Install

```sh
docsloth component add @docsloth/versioned-content@1.0.0
```

Live package: sha256:1e23f883a5debc8a859214dc206755936b9b9541f764618c5c1c7aea4ac88d9c with 2 file digest(s); the catalog entry is generated from the built package, not a placeholder.

## Props

The prop schema is normative in `packages/contracts/component-props/versioned-content.schema.json`.

| Prop | Type | Required | Constraints |
| --- | --- | --- | --- |
| `version` | string \| number | yes |  |
| `label` | string | no | maxLength: 200 |
| `content` | string | no | maxLength: 20000 |

Example props generated from this schema:

```json
{
  "version": "2.0",
  "label": "Applies to v2",
  "content": "Use the v2 client."
}
```

Required props: version.

## Example

Example document IR (the block the renderer consumes):

```json
{
  "type": "versioned-content",
  "props": {
    "version": "2.0",
    "label": "Applies to v2",
    "content": "Use the v2 client."
  }
}
```

Renderer HTML (entities decoded and wrapped for display):

```html
<section class="ds-versioned" data-component="versioned-content" data-version="2.0" aria-label="Applies to v2, version 2.0">
<p class="ds-version-label">Version 2.0</p>
<div class="ds-version-content">Use the v2 client.</div>
</section>
```

Preview (interface-only; the markup above is the same output):

The renderer resolves this component as a native block; the preview above is its real HTML output, and Markdown parity for native blocks is covered by the renderer test suite.

## Specification

Generated from `packages/contracts/component-specs/versioned-content.md`.

### Contract

Packaged: this block ships as `@docsloth/versioned-content@1.0.0` — an installable component package (kind `block`, capability `render.html`, Apache-2.0) whose production props schema is `packages/contracts/component-props/versioned-content.schema.json` and whose catalog entry is in `packages/contracts/component-catalog.json`. No protocol manifest fixture is published (`manifest_fixture: null`): the fixture models a packaged protocol runtime this block does not have.

### Intended behavior

Scope content to a product or API version with an explicit visible label. The AI-native rule is stronger than for visual chrome: Markdown must never hide content, so the version is carried as a `> Version: <version>` blockquote followed by the full body regardless of which version a host page chooses to display.

### Failure and fallback

A missing/empty `version`, or a body that has neither non-empty `content` nor child blocks, degrades the block to the labelled fallback. A non-string `label` is ignored (the version text remains). Content is never dropped: the fallback and the Markdown twin both keep the body.

### Required acceptance cases

A version-scoped block must not silently disappear from the Markdown twin or the JSON view, and switching versions must not change content meaning. Also test empty data, loading, denied access, browser without JS, mobile 360px, keyboard navigation, dark mode and an explicit constrained agent tool call. The server independently authorizes capability requests; a package manifest cannot grant authority.

### Data and maintenance

Data bindings resolve from a specific publication/release vector and permitted fact/evidence graph. Configuration edits create versioned component patches. Update invalidation uses dependency IDs, never indiscriminate whole-page regeneration. Human-owned props survive automatic updates unless invalidated with an explicit conflict. Missing optional resources leave an honest inert/readable fallback, not a broken page or fake success.

### Cost and tools

Pure/local interaction must never invoke a model by accident. Any model, remote query or executor call must reserve approved budget before dispatch. Public visitors do not inherit owner resources. The component may call only named tools in its signed manifest with valid typed inputs. A cancelled job stops polling and closes resources. No component gets platform administration, raw credentials or an unlimited execution loop.

### Native renderer block

`packages/renderer` renders a `versioned-content` block as a `<section data-version="…">` with a visible `Version <version>` label and an accessible region name. `props.label` joins the accessible name (`aria-label`) rather than replacing the visible version text, so HTML and Markdown always expose the same version tokens. Markdown emits `> Version: <version>` followed by the content, and children stay visible after it.

#### Native block props

| prop | type | required | behaviour |
| --- | --- | --- | --- |
| `version` | string \| number | yes | Visible version value, also written to `data-version`. Empty/non-finite values degrade to the fallback. |
| `label` | string | no | Accessible region name (e.g. "Applies to v2"); it does not replace the visible version. |
| `content` | string | no | Body text rendered as a paragraph; escaped in HTML, never hidden in Markdown. |
| `children` | `DocBlock[]` | no | Additional body blocks; the block needs `content` or at least one child. |

#### Example

```json
{
  "type": "versioned-content",
  "props": { "version": "2.0", "label": "Applies to v2", "content": "Use the v2 client." }
}
```

## Package manifest

No protocol fixture is published for this renderer-native block.

| Field | Value |
| --- | --- |
| Fixture | none published |

## Sources

| Source | Path |
| --- | --- |
| Component page | https://registry.docsloth.dev/components/versioned-content.html |
| Markdown twin | https://registry.docsloth.dev/docs/versioned-content.md |
| LLM index | https://registry.docsloth.dev/llms.txt |
| Specification | packages/contracts/component-specs/versioned-content.md |
| Prop schema | packages/contracts/component-props/versioned-content.schema.json |
| Catalog | packages/contracts/component-catalog.json |


---