AI-readable documentation
Canonical tapstate documentation surfaces for search engines, agents, and language models
Tapstate publishes reader HTML and AI-readable Markdown from the same source tree. The llms.txt proposal provides a compact discovery layer, but it does not replace canonical HTML, page metadata, or the sitemap.
Discovery surfaces
Use the smallest surface that answers the task:
| Surface | URL | Purpose |
|---|---|---|
| Canonical documentation | https://tapstate.dev/docs | Primary human and crawler surface with canonical metadata and structured data. |
llms.txt | https://tapstate.dev/llms.txt | Compact index with page links and descriptions. |
llms-full.txt | https://tapstate.dev/llms-full.txt | Combined documentation context for tools that need a single file. |
| Page Markdown | https://tapstate.dev/llms.mdx/docs/<page>/content.md | Canonical page body plus explicit agent metadata and expanded tabs. |
| Sitemap | https://tapstate.dev/sitemap.xml | Canonical reader-page discovery for search engines and crawlers. |
Give an assistant context
For product discovery, start with llms.txt. For a connector or DSL decision,
provide the page-level Markdown so the assistant receives maturity, roles,
modes, limitations, preparation steps, and every tab body.
Read https://tapstate.dev/llms.mdx/docs/connectors/mysql/content.md,
then help me prepare a MySQL Snapshot + CDC source.The public site does not currently expose standalone JSON Schema or example-corpus URLs. Use the DSL reference and the validation interface supplied with your tapstate environment.
Content contract
- Reader HTML is canonical and includes canonical URLs, breadcrumb data, and article structured data.
- Connector frontmatter is a compact discovery index; the page body remains the authoritative explanation.
- Interactive tabs expand into labeled sections in Page Markdown and
llms-full.txt. - Connector maturity distinguishes generally available connectors from connectors that are ready for evaluation.
- A connector catalog describes IDs, fields, roles, and modes, but not whether a deployment has the artifact or can run it. Confirm registration and behavior in the target tapstate environment.
- Schema acceptance proves declaration shape, not runtime execution. The current
runtime executes
nestbut refuses the separately declaredjointransform. - Connector documentation status is derived from the current product directory:
currentorroadmap reference. Other integrations are outside the published documentation contract and machine-readable context. The status is separate from connector maturity and does not add an artifact or runtime support claim.
What assistants can do with these docs
With canonical page Markdown, an assistant can:
- find a connector by system, role, or capture mode;
- explain required permissions and external-system preparation;
- draft
.tap.ymlresources from documented fields; - compare a resource with the reference and repair validation errors;
- preserve page links and limitations in its answer.
Continue with Authoring with AI for a reviewable workflow.