Document the text-assembly pipeline and provenance model #119

New issue

Open

opened 2026-07-01 00:54:39 +00:00 by manlycucumber · 1 comment

manlycucumber commented

2026-07-01 00:54:39 +00:00

(Migrated from github.com)

Problem

The text stack (resolver, assembler, sources, provenance) is new and complex. Contributors and integrators need documentation before the Missal and Breviary build on it.

Acceptance criteria

Pipeline stages from resolver to assembled output are documented
The provenance model and licence gates are explained
Adding a new source is described step by step
LOBVM is used as the worked example

Notes

Reference for v1.2.0 and v1.3.0 teams.

## Problem The text stack (resolver, assembler, sources, provenance) is new and complex. Contributors and integrators need documentation before the Missal and Breviary build on it. ## Acceptance criteria - [ ] Pipeline stages from resolver to assembled output are documented - [ ] The provenance model and licence gates are explained - [ ] Adding a new source is described step by step - [ ] LOBVM is used as the worked example ## Notes Reference for v1.2.0 and v1.3.0 teams.

manlycucumber commented

2026-08-05 19:53:56 +00:00

Owner

Status check — not done, staying open.

docs/design/office-text-layer.md is the design of record and covers the pipeline stages and the provenance/licence model well, but it is a design doc, not the contributor/integrator documentation this issue asks for. Specifically unmet:

"Adding a new source is described step by step" — nothing documents the procedure. SOURCES.md points at a CONTRIBUTING.md that exists in none of the four repos.
"LOBVM is used as the worked example" — §2.5 sketches LOBVM Lauds as a design excerpt, not as a walkthrough of the built pipeline.

Worth doing before v1.3 starts building the Missal on this stack, which is the stated reason for the issue.

Status check — **not done, staying open.** `docs/design/office-text-layer.md` is the design of record and covers the pipeline stages and the provenance/licence model well, but it is a *design* doc, not the contributor/integrator documentation this issue asks for. Specifically unmet: - **"Adding a new source is described step by step"** — nothing documents the procedure. `SOURCES.md` points at a `CONTRIBUTING.md` that **exists in none of the four repos**. - **"LOBVM is used as the worked example"** — §2.5 sketches LOBVM Lauds as a design excerpt, not as a walkthrough of the built pipeline. Worth doing before v1.3 starts building the Missal on this stack, which is the stated reason for the issue.

Directorium referenced this issue from a commit

2026-08-05 19:58:06 +00:00

docs: reconcile SOURCES.md and README with the shipped corpus

No milestone

No project

No assignees

2 participants

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#119

No description provided.

Rows
Columns