Current status
AsyncAPI-backed rendering for the Realtime family is wired intodocs.json from the docs-local mirror api-specs/realtime-server-asyncapi.yaml.
Generated-reference chain
| Layer | Current role |
|---|---|
packages/generated-realtime-api/server/asyncapi.yaml | Authoritative public server-side realtime AsyncAPI artifact |
packages/generated-realtime-api/client/asyncapi.yaml | Adjacent package-owned AsyncAPI artifact in the repo source set |
docs/api-specs/realtime-server-asyncapi.yaml | Docs-local render input used to satisfy Mintlify’s docs-repo path requirement |
| Generated realtime pages under Generated Realtime Channels | Public channel-by-channel rendering layer |
What this means
- generated channel reference now covers the public server-side realtime contract
- manual pages still own connection guidance, REST-bootstrap behavior, and public contract interpretation
- the package-owned AsyncAPI artifacts remain authoritative; the docs-local mirror exists to satisfy Mintlify’s docs-repo path requirement
- mirror refresh is a manual same-change-set requirement today, not a generated post-step
What generated pages own versus manual pages
| Need | Use |
|---|---|
| exact channel, message, and schema lookup | Generated Realtime Channels |
| first subscription path | Realtime Quickstart |
| filtered user-data identity posture | Realtime Authentication |
| reconnect and bootstrap expectations | Connection Model |
| public failure handling | Realtime Errors |
| source-artifact lineage | Realtime Source Artifacts |
Regeneration rule
When the package-owned public realtime AsyncAPI changes:- refresh
docs/api-specs/realtime-server-asyncapi.yamlfrompackages/generated-realtime-api/server/asyncapi.yaml - update the surrounding manual realtime pages if the contract change affects connection, auth, rate-limit, or error claims
- run
mint validateto confirm the docs-local mirror still renders cleanly