Plato documentation

August 4, 2026 · View on GitHub

Start here. This directory holds four kinds of document, and the kind is visible from where the file sits and how it is named.

Naming rule: ALL-CAPS.md means normative. A reader may cite it; changing it is a decision, not an observation. Everything in kebab-case.md is descriptive, historical, or exploratory.


Normative — the rules

DocumentWhat it settles
SEMANTICS.mdWhat Plato constructs mean. The language the checker accepts.
documentation-conventions.mdWhat a durable document here may and may not state.
../stdlib/STYLE_GUIDE.md, ../stdlib/CONVENTIONS.mdHow .plato source is written and named.
../stdlib/VERIFICATION.md, ../stdlib/LIBRARIES.mdWhat the gates check; what each library is for.
../AGENTS.mdHow to work in this repo.

Reference — how things currently work

Maintained, descriptive, superseded by editing rather than by writing a successor.

design/ — proposals and specs

Work that is planned, in flight, or specified but not fully executed. These steer decisions; they do not describe what exists today. When one lands, its content moves into a reference doc and the plan moves to archive/.

reports/ — assessments, surveys, harvests

Frozen at the moment they were written. Read them for the analysis, never for current state: a report is stale by construction. Never edit one to bring it up to date — write a new one.

Casual records — not authority

  • discussions/ — raw conversation transcripts.
  • essays/ — prose written for humans outside the project.
  • archive/ — executed, superseded, or explicitly-not-a-source-of-truth documents, kept for provenance. Nothing here should be linked as a reason to do something.

Generated — never hand-edit

gate-log.md, status-report.html, status-report-snapshot.json, stdlib-ai-summary.txt, types-and-concepts-*.txt. Each is produced by a tool in ../tools/; these are the files allowed to carry measurements, because the date they carry is honest.


Linking rule. Only normative and reference documents may be cited as authority. Link a report, essay, or archived plan only with its date visible in the link text, so a reader knows they are looking at a snapshot.