Labels: testing, documentation
Priority: Low
Estimated Time: 1.5 hours
Description:
backend/src/doc_generator.rs and docs/documentation-generation.md generate docs from code, but there's no CI check confirming committed docs (e.g., docs/api-reference.md) are actually up to date with the generator's current output.
Tasks:
- Add a CI job that regenerates docs and diffs against the committed version
- Fail the build on drift with a clear message on how to regenerate
- Add tests for the generator's output stability (deterministic ordering)
- Document the regeneration workflow in
docs/documentation-generation.md
Labels:
testing,documentationPriority: Low
Estimated Time: 1.5 hours
Description:
backend/src/doc_generator.rsanddocs/documentation-generation.mdgenerate docs from code, but there's no CI check confirming committed docs (e.g.,docs/api-reference.md) are actually up to date with the generator's current output.Tasks:
docs/documentation-generation.md