---
trigger: always_on
---

# Documentation Rules

- Maintain a clear README with setup instructions.
- Document API interactions and data flows.

## Development Phase (Pre-deployment)
- APIs may change without deprecation. Reflect changes immediately:
  - Update OpenAPI docs (`/docs`) and any schema examples with each change.
  - Record notable API surface changes under `docs/api/` (e.g., `docs/api/CHANGELOG.md`) with brief migration notes.

## Post-deployment
- When versions are stabilized (e.g., `api/v1/*`), follow deprecation practices:
  - Document breaking changes and provide upgrade guidance.
  - Keep examples and endpoints in `docs/api/` synchronized with the active versions.