vole-document 0.1.0-alpha.40

Persistent procedural document runtime: byte-exact reconstruction plus a content-addressed procedural seed DAG, queryable observations with provenance, and selective late materialization.
Documentation
# VOLE-Document documentation

Navigational index. The repository entrance is [`../README.md`](../README.md);
the exact-bytes invariant and the operational rules for agents live in
[`../AGENTS.md`](../AGENTS.md).

## Start here

- [Project README]../README.md — what VOLE-Document is, in one page.
- [Security policy and threat model]SECURITY.md — the normative hostile-input contract.

## Architecture (evergreen)

What the system is *today*, with rationale and receipts linked out to ADRs and
phase results.

- [Overview]architecture/overview.md — the idea, the pipeline, the invariant.
- [Authority and exactness]architecture/authority-and-exactness.md — the layered authority model.
- [Inverse proceduralization]architecture/inverse-proceduralization.md — the DRA, residual channels, and the measured structural courts.
- [The document field]architecture/document-field.md — persistent, queryable representation.
- [Observations and provenance]architecture/observations-and-provenance.md — the typed observation algebra, `EXPLAIN`, and partial materialization.
- [Persistence and caching]architecture/persistence-and-caching.md — the seed DAG, stores, indexes, and the derived cache.
- [Multi-format adapters]architecture/multi-format-adapters.md — the shared ZIP layer and the PDF/DOCX/EPUB/ODT/XLSX/PPTX/ODS/ODP natives plus the Wave-2 structured/tabular/web/messaging/analytical adapters.

## Formats

Per-format authority boundaries, native inverse representation, and exactness.

- [PDF]formats/pdf.md
- [DOCX]formats/docx.md
- [EPUB]formats/epub.md
- [ODT]formats/odt.md
- [XLSX]formats/xlsx.md
- [PPTX]formats/pptx.md
- [ODS]formats/ods.md
- [ODP]formats/odp.md
- [JSON]formats/json.md
- [YAML]formats/yaml.md
- [CSV/TSV/PSV]formats/csv.md
- [Fixed-width]formats/fixedwidth.md
- [Markdown]formats/markdown.md
- [reStructuredText]formats/rst.md
- [AsciiDoc]formats/asciidoc.md
- [MDX]formats/mdx.md
- [XML]formats/xml.md
- [HTML]formats/html.md
- [TOML]formats/toml.md
- [JSONL/NDJSON]formats/jsonl.md
- [EML/MIME]formats/eml.md
- [Parquet]formats/parquet.md
- [Arrow IPC]formats/arrow.md
- [JSON5 / JSONC]formats/json5.md
- [CBOR]formats/cbor.md
- [MessagePack]formats/msgpack.md
- [INI / .env / properties]formats/config.md
- [RSS / Atom]formats/feed.md
- [GeoJSON]formats/geojson.md
- [KML / GPX]formats/gis.md
- [Jupyter notebook]formats/notebook.md
- [MHTML]formats/mhtml.md
- [syslog / log streams]formats/logstream.md
- [package metadata]formats/pkgmeta.md
- [API / specification]formats/apispec.md
- [bibliography (BibTeX/RIS/CSL-JSON)]formats/bib.md
- [RTF]formats/rtf.md
- [ZIP / TAR containers]formats/container.md
- [NetCDF classic / HDF5]formats/hdf.md
- [CFBF / OLE2]formats/cfbf.md
- [DOC — legacy Word 97–2003]formats/doc.md
- [XLS — legacy Excel 97–2003 (BIFF8)]formats/xls.md
- [PPT — legacy PowerPoint 97–2003]formats/ppt.md
- [MSG — legacy Outlook message]formats/msg.md

## Reference

- [Specification]reference/specification.md — the `.voldoc` wire format (provisional).
- [Conformance and courts]reference/conformance.md — what is tested and how.
- [CLI]reference/cli.md — the command surface.
- [Format support]reference/format-support.md — capability matrix.

## Research history

Frozen rationale and receipts, kept as a durable record (not rewritten).

- [ADRs]adr/README.md — every frozen decision (through ADR-0060).
- [Phase plans and results]phases/ — the per-phase record. Recent results:
  [Phase 15]phases/phase-15-results.md, [Phase 16]phases/phase-16-results.md,
  [Phase 17]phases/phase-17-results.md, [Phase 18]phases/phase-18-results.md,
  [Phase 19]phases/phase-19-results.md, [Phase 20]phases/phase-20-results.md,
  [Phase 22]phases/phase-22-results.md (economic programme — **complete**:
  22.1 competitor envelope, 22.2 profiling gate, 22.3.0 fused-execution gate,
  22.4 lifetime frontier, 22.5 remote materialization, 22.6
  compact-representation headroom, 22.7 agent cost; 22.2/22.3.0/22.5/22.6/22.7
  are recorded negatives and 22.4 a region split — see
  [phase-22-3-results.md]phases/phase-22-3-results.md,
  [phase-22-4-results.md]phases/phase-22-4-results.md,
  [phase-22-5-results.md]phases/phase-22-5-results.md,
  [phase-22-6-results.md]phases/phase-22-6-results.md,
  [phase-22-7-results.md]phases/phase-22-7-results.md),
  [Phase 23]phases/phase-23-results.md (durability: directory `fsync` + a
  model-based power-loss proxy),
  [Phase 25]phases/phase-25-results.md (durability corrections: directory
  ancestry + unpublished-segment recovery),
  [Phase 26]phases/phase-26-results.md (legacy DOC/XLS/PPT/MSG semantic models +
  stratified real-world population v2 + the pyarrow Arrow comparator lane),
  [Phase 27]phases/phase-27-results.md (legacy DOC CP sections + PPT
  `SlideListWithText` lists, detection hardening that took the stratified-v2 court
  from 32 to 21 findings, legacy economic courts with Lane C `comparator_absent`,
  and magic-less Arrow IPC **stream** detection),
  [Phase 28]phases/phase-28-results.md (the performance programme — detection
  completion **21 → 15**, a repaired competitor envelope with real Arrow for
  DuckDB and an in-process steady-state headline, a recorded-negative hot-path
  profiling gate, and the three decision experiments: **28.5** fused Arrow kernel
  RESOLVED POSITIVE, **28.6** fragment locality — coarse structural index
  justified, **28.7** revision reuse — positive but marginal/scoped; the winning
  mechanisms then ship in Phase 29),
  [Phase 29]phases/phase-29-results.md (the winning mechanisms — **29.1** the
  generalized fused kernel over Arrow/Parquet/CSV/fixed-width: a resolved
  steady-state win over the shipped path and **every** DuckDB cell, with the
  large-input pyarrow gap narrowed **6.46× → ~2.7–3.0×**; **29.2** the coarse
  structural index: three real defects fixed, span closure beats the
  whole-descriptor control **4/4** with a recorded reading-request loss; **29.3**
  revision-aware incremental observation: correct with the semantic edges but
  **MARGINAL/scoped** on index cost),
  [Phase 30]phases/phase-30-results.md (closing the measured gaps — **30.1
  shipped**: the large-input fused kernels take Arrow **≈2.87 → 0.65** and
  Parquet **≈1.28 → 0.61** past pyarrow (**every cell `< 1.0`**) and improve CSV
  **≈46.2 → 35.5** (still 10.5–42× slower — the remaining recorded loss), with
  the full-matrix pyarrow median **0.0772 → 0.0461** (W/T/L **406/41/163 →
  489/8/81**), exactness **3/3 · 12/12**, and the econ court's `IFS` defect
  fixed; **30.2** coarse index for reading, **30.3** incremental index cost, and
  **30.4** standing negatives are **PENDING**),
  **in progress**:
  [Phase 21]phases/phase-21-plan.md (format programme — **Wave 1 complete**: XLSX,
  PPTX, ODS, ODP adapters + economic courts = six office formats; **Wave 2
  complete**: JSON, YAML, CSV/TSV, Markdown, XML, HTML, TOML, JSONL, EML/MIME,
  Parquet and Arrow IPC adapters + economic courts, plus the subphases 21.17–21.24
  (JSON5/JSONC, CBOR, MessagePack, config, RSS/Atom, GeoJSON, KML/GPX, Jupyter
  notebook), 21.25/21.26 (PSV + fixed-width; reStructuredText + AsciiDoc + MDX) and
  the final families 21.27–21.35 (MHTML, log streams, package metadata, API/spec,
  bibliography, RTF, ZIP/TAR containers, NetCDF classic/HDF5 subset, CFBF/OLE2
  physical layer) adapters + economic courts; also a permanent cross-field
  identity court, a stratified real-world court, and the JSON/YAML span-preserving
  comparator corrections: the legacy DOC/XLS/PPT/MSG *semantic* models on top of
  CFBF **now ship in [Phase 26]phases/phase-26-results.md** (adapter courts +
  the stratified real-world population v2 + the pyarrow Arrow comparator lane), so
  those are no longer future work); the Phase 22 programme is pre-registered in
  [phase-22-plan.md]phases/phase-22-plan.md.
- [Independent reviews]reviews/ — adversarial skeptic findings.
- [Evidence index]evidence/README.md — campaigns and measurement reports.

## Project

- [Status and mechanism ledger]project/status.md — the single authoritative status table.
- [Findings]project/findings.md — consolidated results, positive and negative.
- [Roadmap]project/roadmap.md — open `PROPOSED` items.
- [Changelog]project/changelog.md — release history.
- [Documentation migration ledger]project/doc-migration-ledger.md — where every old section went.