Document the output contract and stability guarantees #58

New issue

Closed

opened 2026-07-01 00:52:29 +00:00 by manlycucumber · 0 comments

manlycucumber commented

2026-07-01 00:52:29 +00:00

(Migrated from github.com)

Problem

Downstream teams need a written contract spec with the shape, the data-version stamp, stable IDs, and the stability promise so they can build safely against Core.

Acceptance criteria

A contract document describes every field and its meaning
Stability and versioning guarantees are stated explicitly
Examples of a simple and a complex day are included
The doc is linked from the package README

Notes

This doc is frozen in v1.0.0.

## Problem Downstream teams need a written contract spec with the shape, the data-version stamp, stable IDs, and the stability promise so they can build safely against Core. ## Acceptance criteria - [ ] A contract document describes every field and its meaning - [ ] Stability and versioning guarantees are stated explicitly - [ ] Examples of a simple and a complex day are included - [ ] The doc is linked from the package README ## Notes This doc is frozen in v1.0.0.

manlycucumber referenced this issue from a commit

2026-08-05 19:02:29 +00:00

docs: complete the output-contract spec and stability guarantees (#58) (#359)

No milestone

No project

No assignees

1 participant

Notifications

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference

Directorium/Core#58

No description provided.

Rows
Columns