Context
External developers and OAuth apps need an API reference that matches the code. Docs are on Mintlify (0002), which renders OpenAPI, and Encore endpoints (0032) are typed.Decision
- An OpenAPI document is generated from the Encore endpoints, not written by hand.
- The Mintlify API reference is built from that document in
apps/docs. - An OAuth developer guide covers registering an app, scopes, the authorisation flow and tokens, and is written with the OAuth-apps feature.
- The generator and whether the document is committed or built: TODO.
Consequences
- The reference cannot drift from the code if CI regenerates it; internal-only endpoints must be excluded.
Enforcement
Planned — CI step that regenerates the OpenAPI document and fails on a diff;mint broken-links already checks the docs pages.