#92, #93) #475

Merged

manlycucumber merged 1 commit from feature/91-reference-docs into develop

2026-07-10 22:19:47 +00:00

manlycucumber commented

2026-07-10 22:18:13 +00:00

(Migrated from github.com)

What

Epic #91 — reference documentation: the authoritative consumer-facing guide, defining the public surface the Api/Site/Ordo build on (and that #88 will freeze).

docs/integration-guide.md (#92) — install, the public API (day() / contract() / explain(); resolvedYear() marked @internal), the two selectors ($rubricSystem edition, $calendar overlay), the Compare API, the output contract (linked), and worked examples.
docs/calendars-and-editions.md (#93) — plain-language reference for the three editions (1962/1954/1955) and the overlays (SSPX/FSSP/ICKSP/Generic): what each is, who follows it, its selector value, and its cited source; Cum sanctissima noted as deferred.
README — fixed the stale usage block (it referenced a non-existent LiturgicalCalendar class and claimed "frozen at 1.0.0"; the real API is the day()/contract() functions and the contract is 1.0.2) and linked both guides.

Verification

Every documented example was run against the engine and produces the claimed output:

day(2026-06-30) → commemoratio-pauli / III / red
contract(2024-08-14, false, null, '1954') → edition roman:divino-afflatu, Vigil of the Assumption class 4
contract(2026-09-03, false, 'sspx') → directorium:overlay:roman:sspx, St Pius X class 1
explain(2026-11-02) → carries the resolution slot
the CalendarComparator / SequenceComparator snippets run

All four referenced composer scripts (lint/analyse/test/validate-oracles) exist. Docs-only change — no code touched.

Closes #92, closes #93.

## What Epic **#91 — reference documentation**: the authoritative consumer-facing guide, defining the public surface the Api/Site/Ordo build on (and that #88 will freeze). - **`docs/integration-guide.md`** (#92) — install, the public API (`day()` / `contract()` / `explain()`; `resolvedYear()` marked `@internal`), the two selectors (`$rubricSystem` edition, `$calendar` overlay), the `Compare` API, the output contract (linked), and worked examples. - **`docs/calendars-and-editions.md`** (#93) — plain-language reference for the three editions (1962/1954/1955) and the overlays (SSPX/FSSP/ICKSP/Generic): what each is, who follows it, its selector value, and its cited source; Cum sanctissima noted as deferred. - **README** — fixed the stale usage block (it referenced a non-existent `LiturgicalCalendar` class and claimed "frozen at 1.0.0"; the real API is the `day()`/`contract()` functions and the contract is `1.0.2`) and linked both guides. ## Verification **Every documented example was run against the engine** and produces the claimed output: - `day(2026-06-30)` → `commemoratio-pauli / III / red` - `contract(2024-08-14, false, null, '1954')` → `edition roman:divino-afflatu`, Vigil of the Assumption **class 4** - `contract(2026-09-03, false, 'sspx')` → `directorium:overlay:roman:sspx`, **St Pius X class 1** - `explain(2026-11-02)` → carries the `resolution` slot - the `CalendarComparator` / `SequenceComparator` snippets run All four referenced composer scripts (`lint`/`analyse`/`test`/`validate-oracles`) exist. Docs-only change — no code touched. Closes #92, closes #93.

manlycucumber referenced this pull request from a commit

2026-07-12 18:46:22 +00:00

docs: Core integration guide + calendars/editions reference (#92, #93) (#475)

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

No description provided.

Rows
Columns