Release notes

What changed and what breaks — breaking changes as a warning callout.

Use this templateDocs template
Release notesWhat changed and what breaks — breaking changes as a warning callout.

v<x.y.z> — <the headline change>

Released: <date> · Upgrade effort: <none | minutes | plan it>

Highlights

  • <Feature> — <what it lets you do that you couldn't yesterday>
  • Smart import — drag a folder of Markdown or Notion exports and watch it land as clean docs

New

  • <Addition, described from the customer's side>
  • Import preview step — see the parsed result before you commit

Improved

  • <Improvement, with the number if you have one>
  • Onboarding is 3× faster to first real doc

Fixed

  • <The bug, as the user experienced it — not as the ticket described it>
  • Pasted images now embed at the caret instead of the document end

Upgrade notes

Warning

Breaking — <what breaks, when the old path stops working, and the one-line migration>.

Warning

The import API moved from /v1/import to /v2/import. The old route 308-redirects until 2026-09-01, then returns 410.