From ee067633397180d246479b7326680dfd281ca871 Mon Sep 17 00:00:00 2001 From: Daniel Ari Friedman Date: Wed, 3 Jun 2026 05:17:32 -0700 Subject: [PATCH] fix(ci): restore missing doc pairs to green main PR #11 merged with two directories lacking their required README/AGENTS pair, turning main's CI red (Documentation Lint + doc-pair infra tests): - docs/reference/ (had method-inventory.md + rendering-reproducibility.md only) - src/validation_spine/ (had README.md only) Add the missing files; lint_docs + test_doc_pair_lint now pass. --- .../docs/reference/AGENTS.md | 13 +++++++++++++ .../docs/reference/README.md | 13 +++++++++++++ .../src/validation_spine/AGENTS.md | 15 +++++++++++++++ 3 files changed, 41 insertions(+) create mode 100644 projects/templates/template_active_inference/docs/reference/AGENTS.md create mode 100644 projects/templates/template_active_inference/docs/reference/README.md create mode 100644 projects/templates/template_active_inference/src/validation_spine/AGENTS.md diff --git a/projects/templates/template_active_inference/docs/reference/AGENTS.md b/projects/templates/template_active_inference/docs/reference/AGENTS.md new file mode 100644 index 000000000..7fd336da2 --- /dev/null +++ b/projects/templates/template_active_inference/docs/reference/AGENTS.md @@ -0,0 +1,13 @@ +# Agent Notes + +`projects/templates/template_active_inference/docs/reference/` is documentation +only — reference lookups, not business logic. Keep logic in `../../src/`, +orchestration in `../../scripts/`, and generated artifacts under `../../output/`. + +- **method-inventory.md** must stay in step with the methods actually defined in + `../../src/`; when you add or rename a method/track, update its row here. +- **rendering-reproducibility.md** documents the deterministic render contract + (fixed seeds, pinned inputs); update it when the render pipeline changes. + +Every directory under `docs/` carries a `README.md` (user-facing) and an +`AGENTS.md` (this technical note) — the repo's doc-pair lint enforces both. diff --git a/projects/templates/template_active_inference/docs/reference/README.md b/projects/templates/template_active_inference/docs/reference/README.md new file mode 100644 index 000000000..6f09122b2 --- /dev/null +++ b/projects/templates/template_active_inference/docs/reference/README.md @@ -0,0 +1,13 @@ +# Reference + +Reference material for the Active Inference exemplar — stable lookups that +support the manuscript and the track pipeline. + +- [method-inventory.md](method-inventory.md) — catalogue of the analytical / + pymdp / Lean / GNN / ontology methods exercised by the tracks, and where each + is defined in `../../src/`. +- [rendering-reproducibility.md](rendering-reproducibility.md) — how the + manuscript and figures are rendered deterministically (seeds, pinned inputs, + regenerate-from-clean steps). + +See the parent [docs/README.md](../README.md) for the full documentation map. diff --git a/projects/templates/template_active_inference/src/validation_spine/AGENTS.md b/projects/templates/template_active_inference/src/validation_spine/AGENTS.md new file mode 100644 index 000000000..bf4dd2ad8 --- /dev/null +++ b/projects/templates/template_active_inference/src/validation_spine/AGENTS.md @@ -0,0 +1,15 @@ +# Source Module Notes + +`validation_spine/` holds the deterministic artifact contracts for the Active +Inference exemplar. All reusable, tested logic lives here; `../../scripts/` +(e.g. `generate_validation_spine.py`) only parses arguments, resolves paths, and +calls these functions (thin-orchestrator pattern). + +- `artifacts.py` writes and validates the artifact-provenance, deterministic + replay, and counterexample-matrix records consumed by the gate tests before + manuscript/output validation. +- Keep every contract deterministic (fixed seeds, no network, no runtime + downloads) so replays are byte-stable. +- The validation spine runs ahead of manuscript/output validation; changes here + must keep the five tracks (prose / formalism / numerics / pymdp / Lean) + concordant.