Severity: low
Domain: docs
Status: VERIFIED — measured against a210d34 on 2026-08-10
Suggested labels: documentation
Summary
AGENTS.md requires a design-first doc/<domain>/<Name>.md per algorithm. Twelve
production units have none. A separate set of index/naming mismatches is listed below.
Measurement
$ for h in $(find numerical -name '*.hpp' -not -path '*/test*' -not -path '*/platform/*'); do \
b=$(basename "$h" .hpp); \
find doc -name "$b.md" | grep -q . || echo "$b ($h)"; \
done
Units correctly covered by combined pages were then excluded manually:
DormandPrince45 → RungeKuttaIntegrators.md, L1/L2 → Regularization.md,
Windowing → window.md.
Genuinely undocumented
Interface-only headers (Solver, Estimator, ObjectiveFunction, OdeSystem, the controller
interfaces, CompilerOptimizations) are excluded — they arguably do not need algorithm pages, but a
policy decision would help.
Index and naming mismatches
Suggested fix
Add pages per doc/TEMPLATE.md, update the domain README.md tables, and
decide whether pure interfaces are exempt (then state that in AGENTS.md).
Severity: low
Domain: docs
Status: VERIFIED — measured against
a210d34on 2026-08-10Suggested labels:
documentationSummary
AGENTS.md requires a design-first
doc/<domain>/<Name>.mdper algorithm. Twelveproduction units have none. A separate set of index/naming mismatches is listed below.
Measurement
Units correctly covered by combined pages were then excluded manually:
DormandPrince45→RungeKuttaIntegrators.md,L1/L2→Regularization.md,Windowing→window.md.Genuinely undocumented
StatisticsMatrixToeplitzGeometry3DRecursiveBufferToleranceComplexNumberQNumberMath/ConstexprMathKalmanFilterBasePidIncrementalFastFourierTransformRadix2ImplInterface-only headers (
Solver,Estimator,ObjectiveFunction,OdeSystem, the controllerinterfaces,
CompilerOptimizations) are excluded — they arguably do not need algorithm pages, but apolicy decision would help.
Index and naming mismatches
"(Coming soon — FIR and IIR filter documentation)" although both pages exist.
Pid, but the implementation isPidIncremental— no header matches the page name.Suggested fix
Add pages per doc/TEMPLATE.md, update the domain
README.mdtables, anddecide whether pure interfaces are exempt (then state that in
AGENTS.md).