Documentation

Protocol

Versioning

The protocol follows semantic versioning at the schema level. Every package declares the protocol_version it targets, so consumers can negotiate compatibility.

Current version

v0.1
experimental

The schema is stable enough to build against. Breaking changes are still possible before v1.0.

Policy

  • MAJOR — incompatible schema changes (renamed fields, removed sections, changed types).
  • MINOR — backward-compatible additions (new optional fields, new section, new enum value).
  • PATCH — clarifications and fixes that do not affect serialized packages.

Migration

When the protocol bumps a major version, this site publishes a migration guide alongside the new spec. Older packages remain valid against their declared protocol_version; consumers decide whether to upgrade.

No automatic upgrade

The protocol does not promise lossless upgrades across major versions. The migration guide will list which fields require manual review.

Proposing a change

Open a discussion on the GitHub repository. Substantive changes go through a short RFC describing the problem, the proposed schema delta, and at least one worked example.