- Results holds the measured output: allele frequency, linear regression, suppression and straggler scenarios, and the scaling figures. The root README carries only the summary.
- Variable dictionary describes the implemented canonical variables and the mock-TRE local names. Those names are synthetic and are not schemas agreed with real TREs.
- Demo specs describes the example analysis specifications in
spec/examples/and their documented limits. - Controlled local-steps comparison records the federated-averaging measurements that vary only
local_steps, with the environment they were taken in and what they do and do not establish.
- Roadmap holds the original project goals in full. They are targets and historical intent, not current behaviour.
- Build plan is the milestone-based implementation plan. It records proposed and historical intent; use the repository and root README to establish current behavior.
- API architecture use case is a proposal.
- The current implemented flow is documented in the editable Draw.io source, SVG overview, and PNG overview. Regenerate the SVG and PNG from the Draw.io source when changing the overview.
- Scaling plot and scaling data record the existing simulation evidence.
notes/ is ignored. Keep drafts and reports in notes/reviews/, decks in notes/presentations/, and cleanup records in notes/maintenance/. Add a file deliberately only when it is project documentation intended for collaborators.