Meta

Release Notes Policy

How docs and API changes are tracked.

What should be tracked

  • New public exports
  • Breaking signature changes
  • Event contract changes
  • Configuration surface changes

Process

  • Regenerate docs on API changes
  • Run docs consistency checks
  • Update migration notes when compatibility behavior changes

Latest branch updates (2026-02-09)

  • Hardened signature, content-editing, and save lifecycle compatibility APIs.
  • Improved Instant JSON persistence for outline/signature metadata.
  • Tightened viewer event payload typings and normalized form value payload emission.
  • Extracted and unit-tested transform geometry helpers; hardened render export error handling.
  • Regenerated API/event docs to reflect current typed payload contracts.

API Surface Metrics (generated)

Current generated documentation summary:

  • Viewer methods: 138
  • Viewer events: 79
  • Compatibility events: 8
  • Viewer configuration properties: 18

Refresh these metrics with:

npm run docs:generate