Documentation style

Add a capability

1. Create docs/capabilities/<capability-name>/index.md.
2. Add a version folder, such as v1.
3. Add one Markdown file per endpoint. Copy docs/templates/endpoint.md.
4. Add the capability and endpoint links to sidebar in docs/.vitepress/config.mts.

File names

Use lowercase kebab-case, for example create-user.md. The folder landing page is index.md. VitePress also accepts README.md as that landing page.

Page contents

Each endpoint page includes the method and path, parameters, a request example, a response example, errors, and a change history.