Add another backend surface
When you are ready to documentuser-api or admin-api, keep the same order of operations:
- Extend
docs/api-spec.openapi.yamlif you want a single combined starter spec. - Or split into multiple shared spec files under
docs/if the combined file becomes too large. - Mirror each source file into
frontend/docs/openapi/. - Add navigation entries in
frontend/docs/docs.json.
Add more narrative content
The API reference should not carry all of the explanation. Good next pages to add:- authentication model
- tenancy model
- webhook lifecycle
- client integration quickstarts
Keep the starter generic
Avoid baking product-specific copy, brand promises, or internal-only operational detail into the initial scaffold. The starter should explain:- what the platform provides
- how to run it locally
- how to keep the API reference current