Contract index¶
Truth hierarchy: on-disk project + page results are authoritative for each notebook today. Archive SQLite is disposable derived state (rebuildable search/timeline cache). Analysis outputs are authoritative only inside the managed project’s analysis/ tree. Bulk-import generation adds a workspace corpus index + ImportRun authority (runtime-normative; see activation gate). Invariants live in the CONTRACT docs below — not in README, guides, or architecture.
Concept |
Authority |
|---|---|
Supported entrypoints (CLI / UI / scripts) |
|
Corpus hierarchy, |
|
Managed originals, fingerprints, duplicates, source/render invariants |
|
ImportRun / ImportPlan lifecycle, idempotency, crash/resume |
|
Multi-notebook OCR batch (OcrBatchRun) |
|
Multi-notebook Analyse batch (AnalysisBatchRun) |
|
Corpus/notebook doctor invariants, repair boundaries, bulk-import acceptance gate |
|
Project directory layout, |
|
Page results, attempts, edits, fingerprints, prefer/compare (persisted) |
|
OCR multipass job records, rank/composite phases |
|
OCR preference ledger / rollup |
|
Fine-tune dataset export package |
|
Portable notebook export |
|
Canonical analysis input, content fingerprint, |
|
Analysis result envelope, outcomes vs attempts, capability UI states, provenance, evidence |
|
Analysis persistence, cache identity, hard/optional parents, atomic publish |
|
Prompt definitions, rendering boundary, schema identity |
|
Organisation tag catalog (slugs / labels / colours; TX copy-boundary) |
|
Detector definitions, scope, candidate strategy |
|
Detection findings, cross-page spans, review status |
|
Detection result envelope, outcomes, capability |
|
Detection persistence, cache identity, aggregation |
|
Page ink / blankness / hue metrics (Pillow; active renders) |
|
Sole notebook eligibility policy ( |
|
Durable UI action-menu prefs ( |
|
Workspace settings ( |
|
Full-workspace backup ZIP / restore (role roots, verify, replace-only) |
|
Future TranscriptX handoff (non-shipped) |
Schema identity and version gates in code: transcribe.persistence.schema.SUPPORTED (transcribe.project, transcribe.page-result, transcribe.notebook, transcribe.analysis-document, transcribe.analysis-result, transcribe.detection-result, transcribe.prompt-definition, transcribe.page-metrics, plus transcribe.corpus-index, transcribe.import-run, transcribe.ocr-batch-run, transcribe.ingest-journal, transcribe.workspace-backup, personal_corpus.tag-catalog, transcribe.detection-auto-tag — all version 1 today). Interface menus use a separate envelope (schema_version 1) under data/config/interface_menus.json — see the interface-menus contract. Corpus formats are runtime-normative for bulk import (activation gate satisfied) but are not required for transcribe.project v1 notebooks that lack corpus registration.