voussoir

Compatibility policy

The crate is 0.x, so Cargo's 0.x rules already allow any minor bump to break. What Voussoir promises on top of that:

Breaking changes

These require a 0.x bump and a CHANGELOG entry under its own heading:

Not breaking

The shim protocol

The shim carries its own version, voussoir.protocol, separate from the crate version. It exists so a frontend can feature-detect instead of probing for methods:

if (window.voussoir.protocol >= 2) {
  const open = await window.voussoir.windows();
}

The current version is 2, which added windows(). tray and menu arrived in the same release but are additive on the object, so a page that feature-detects on protocol >= 2 and then calls voussoir.tray should still guard for its absence on an older shell.

How a change is recorded

Every user-visible change is in CHANGELOG.md in Keep a Changelog format, so "is this upgrade safe for my app?" is answerable from the changelog plus the lists above. The version in voussoir.json and the version of the voussoir crate are separate on purpose: an app does not have to adopt a new shell to keep its frontend working.

Edit this page on GitHub