# ECRuntime documentation

Three directories, three questions. A fact lives in exactly one of them; the others link
to it.

| Directory | Question | Character |
|---|---|---|
| [`history/`](history/README.md) | What was done, and when? | chronological, append-only |
| [`current/`](current/README.md) | What holds today? | kept up to date |
| [`roadmap/`](roadmap/README.md) | What comes next, from which papers? | plan |

## history/

- [`README.md`](history/README.md) — chronological index across all lines (generated)
- one file per research line: [`foundations.md`](history/foundations.md),
  [`generic-runtime-theory.md`](history/generic-runtime-theory.md),
  [`boettcher-doerr-neumann-2010.md`](history/boettcher-doerr-neumann-2010.md),
  [`witt-2013.md`](history/witt-2013.md),
  [`doerr-janett-lengler-2024.md`](history/doerr-janett-lengler-2024.md), and
  [`repository.md`](history/repository.md) for merge, verification and tooling events
- [`archive/`](history/archive/) — documents frozen at Stage 79, read, never extended

## current/

- [`README.md`](current/README.md) — checkpoint, last gate, scope and limits, known open
  items, status vocabulary and the paper-by-paper coverage table
- [`papers/`](current/papers/) — one file per paper with certified results
- [`facades.md`](current/facades.md) and [`graphs/`](current/graphs/) — public modules and
  proof dependencies (generated)

## roadmap/

- [`README.md`](roadmap/README.md) — priorities and the near-term plan
- [`frontier.toml`](roadmap/frontier.toml) — the machine-readable queue
- [`papers/`](roadmap/papers/README.md) — one file per candidate paper (index generated)
- [`TEMPLATE-paper.md`](roadmap/TEMPLATE-paper.md) — the template for proposing a paper
  (mode 1 in [`CONTRIBUTING.md`](../CONTRIBUTING.md))

## Conventions

- A paper has one key in every directory: `<first-author>-<year>`, with all surnames up to
  three authors (`doerr-janett-lengler-2024`) and `<first>-et-al-<year>` from four.
- Generated files carry a "Generated by" comment. Regenerate them, never edit them by
  hand:

  ```bash
  pwsh -File scripts/facade_index.ps1        # current/facades.md
  pwsh -File scripts/docs_index.ps1 -Check   # history and roadmap indexes, link and pin checks
  ```