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

Merged

manlycucumber merged 1 commit from feature/58-contract-docs into develop

2026-07-02 04:57:07 +00:00

manlycucumber commented

2026-07-02 04:56:11 +00:00

(Migrated from github.com)

Closes #58. Final issue of Epic #52.

Completes docs/design/output-contract.md as the frozen v1.0.0 reference downstream teams build against, and links it from the README.

Every field of the day and office shapes, each with its type and source.
Versioning & stability: the three-version scheme (contract/corpus/engine), the closed vs open enum catalogue, the patch/minor/major bump rules, and the explicit stability promise.
Reserved-slot table (day- and office-level), the colour & rose note, the day-boundary / First Vespers semantics, and the id-vs-urn compatibility surface.
Worked examples: a simple day (2025-07-15) and a complex transfer day (St Joseph impeded 2017-03-19 → landing 2017-03-20), reusing the pinned snapshots. Example values verified against live output.
README gains an Output contract section linking the spec.

Docs-only; local gate unchanged (492 tests / 30,478 assertions green).

Closes #58. Final issue of Epic #52. Completes `docs/design/output-contract.md` as the **frozen v1.0.0 reference** downstream teams build against, and links it from the README. - **Every field** of the day and office shapes, each with its type and **source**. - **Versioning & stability**: the three-version scheme (contract/corpus/engine), the closed vs open **enum catalogue**, the patch/minor/major **bump rules**, and the explicit stability promise. - **Reserved-slot table** (day- and office-level), the **colour & rose** note, the **day-boundary / First Vespers** semantics, and the id-vs-urn compatibility surface. - **Worked examples**: a simple day (2025-07-15) and a **complex transfer day** (St Joseph impeded 2017-03-19 → landing 2017-03-20), reusing the pinned snapshots. Example values verified against live output. - README gains an **Output contract** section linking the spec. Docs-only; local gate unchanged (492 tests / 30,478 assertions green).

manlycucumber referenced this pull request from a commit

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

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

No reviewers

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!359

No description provided.

Rows
Columns