Releases
Release docs should help operators and developers understand what changed, what to test, and whether an upgrade affects compatibility.
What belongs in release docs
Section titled “What belongs in release docs”- User-visible behavior changes.
- Admin portal changes.
- API changes.
- Token or claim changes.
- Database migrations.
- Client SDK changes.
- Security fixes.
- Deprecated behavior.
- Upgrade steps.
Where to start
Section titled “Where to start”Use Changelog for a chronological summary and Compatibility for upgrade notes that require action.