Where release notes live

One system of record, and what everything else is a copy of.

Written By Dustin

Last updated 23 minutes ago

Release notes live in the changelog on the documentation site: https://docs.tovio.dev/resources/changelog/. That page is the system of record.

Everything else is downstream

You will also see release information as an Updates entry on the feedback portal, as a Shipped status on the post you voted for, and in the release itself. All three are copies. None of them ever says anything the changelog does not already say.

This matters when they appear to disagree: the changelog is right. An update published from a stale draft, or a status set on the wrong post, is a mistake in the copy — and worth telling us about on the Docs & quickstart board.

The order things happen in

  1. The change lands, citing its engineering ticket and the post it came from.
  2. The release edits the changelog first, before anything is published anywhere else.
  3. The documentation deploys.
  4. Each originating post is set to Shipped, with notification on, linking the changelog entry.
  5. The Updates entry is published, mentioning those posts.

If you are reading an announcement with no changelog entry behind it, it went out early. That is a bug in the release process, not a preview.

Product updates on the portal

The portal's Updates section is a web page and an RSS feed. Update emails are switched off entirely for now: subscription is opt-in, and the mailing stays disabled until enough people have opted in for it to be worth sending, so subscribing today puts you on a list rather than in an inbox. Reading the changelog, or subscribing to the feed, is the reliable route.

Once a month, if anything shipped, the Updates section also carries a short "you asked, we shipped" summary mirroring that month's changelog entries and mentioning the posts they closed. If nothing shipped there is no entry, because an empty update is worse than none.

Version numbers

TOVIO is pre-1.0. The changelog is where a breaking change is announced, and it is worth reading before an upgrade rather than after one.