- a clean Mintlify documentation surface in
frontend/docs - a shared OpenAPI file in
docs/api-spec.openapi.yamlthat acts as the source of truth for API reference content
- The docs site is generic enough to reuse across products.
- The initial API reference covers
public-apionly. - The rendered reference is driven from a mirrored OpenAPI file inside the docs app, but the file you should edit is always
docs/api-spec.openapi.yaml.
What ships
- Intro, quickstart, architecture, and maintenance guides
- Mintlify navigation and API reference wiring
- A shared OpenAPI starter document for
public-api - A small sync script so the Mintlify project can consume the shared spec without becoming the source of truth itself
Starter assumptions
- Narrative docs and API docs should evolve together.
- Route changes should update the shared OpenAPI file in the same pull request.
- Mintlify is a standalone app here, not part of the root npm workspaces.