Release Notes

This section contains detailed release notes for each product version, including new features, improvements, and bug fixes.

Release Documentation Structure

Core Documentation

Release Notes (release-notes.md):

  • Always required for every release
  • Contains features, improvements, bug fixes, and breaking changes
  • Provides overview of what’s new in this version

Optional Documentation

Additional documentation files are created when a release includes significant changes in specific areas:

Deployment Changes (deployment.md):

  • Document config changes, migrations, infrastructure updates
  • Include rollback procedures
  • Required for: DB migrations, env var changes, breaking deployments

Booking Client API Changes (booking-client-api.md):

  • Document new/changed/removed APIs in the renderer
  • Include migration examples
  • Required for: Breaking changes, new public APIs, deprecations

Booking Service API Changes (booking-service-api.md):

  • Document REST API endpoint changes
  • Include request/response examples
  • Required for: API v1/v2 changes, authentication changes, webhook updates