Initial commit

This commit is contained in:
2025-10-04 16:16:05 -04:00
commit d38a1ab86c
14 changed files with 436 additions and 0 deletions

18
documentation.md Normal file
View File

@@ -0,0 +1,18 @@
---
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.