| id | docs-index |
|---|---|
| type | semantic |
| created | 2026-07-03 00:00:00 -0400 |
| diataxis_type | reference |
| title | Documentation index |
This documentation is organized per Diátaxis: four kinds of content, each answering a different question. Pick the section that matches what you're trying to do.
Start here if you're new to the plugin.
- Get started with the error-handling plugin — install the plugin and watch
cdc-reviewandcdc-errtrigger on a real piece of code, start to finish.
You already know what you want to do; these are the steps.
- Install the plugin
- Add cdc-err dual-format output to an existing CLI
- Run and improve the skill evals
- Verify a release
- How the marketplace catalog gets pinned to a release
Dry, exhaustive material you consult, not read start to finish.
- Reference index — envelope schema, severity taxonomy, language-specific patterns, plugin/marketplace manifest fields, trigger phrases.
Background, rationale, and design decisions.
- Why CLI errors are a dual-consumer problem — the framing
cdc-erris built on. - Why three sibling skills, not one — why the plugin splits producer / propagation / consumer across
cdc-err,cdc-review, andcdc-handle. - Why this plugin ships an attested release pipeline — why fail-closed release verification is worth building, and why it's scoped the way it is.
Not a Diátaxis quadrant — a separate genre for the architecturally significant, hard-to-reverse decisions behind this repo's structure.
- ADR index — why the repo is both a plugin and its own marketplace, the release pipeline's attestation scope, the signer topology, release auth, catalog SHA-pinning, and the branch model.
Outside docs/, at the repository root:
- README.md — project overview, installation quick-start, plugin layout.
- CHANGELOG.md — Keep a Changelog history.
- SECURITY.md — vulnerability reporting, release verification model.