yams/docs/developer/architecture
trvon a3fd678f82
chore(bench): keep xplan local
Stop shipping the experiment harness and compatibility wrappers while preserving them as gitignored local tooling. Remove stale Meson registrations and mark recorded benchmark numbers as historical.
2026-07-27 18:10:38 -04:00
..
README.md chore(bench): keep xplan local 2026-07-27 18:10:38 -04:00

Developer Architecture Notes

This index points to architecture references that mirror the live implementation. Always validate statements against the cited source modules.

Core Architecture References

Supporting Design Notes

API References

Operations and Performance Guides

Contribution Workflow

  1. Update architecture docs and any related traceability artifacts in the same change set.
  2. Anchor new prose to specific functions, classes, or modules under src/.
  3. Capture validation evidence (integration logs, benchmarks) alongside the change with timestamps.
  4. Run mkdocs build --strict and archive the log before submitting changes.
  5. Flag future work explicitly with issue references; avoid speculative language.

Missing topics should be proposed via issue (outline + intended source references) prior to documentation work.