Bounded Documentation Generation
Introduced a deterministic Abbey Docs workflow for the two proven CLI documentation generators.
Tags: Abbey Root • Abbey Framework • Developer Toolkit • Documentation • Automation
Bounded Documentation Generation
Summary
Abbey Root now has one discoverable command for generating and checking the two tracked CLI references whose inputs are fully repository-local and deterministic.
Accomplishments
- Added
abbey docs generatefor the metadata-driven CLI reference and legacy command-header reference. - Added
abbey docs checkas a read-only freshness check. - Removed a volatile timestamp that prevented repeatable command-reference generation.
- Preserved the existing Ansible workflow for environment-dependent infrastructure documents.
- Added regression coverage for idempotency and stale-output detection.
Lessons Learned
- Generated files need an explicit source-to-output contract before they can safely share an orchestration command.
- A bounded automation layer is more useful than an “all documentation” command whose success would hide outputs that cannot yet be checked deterministically.
Next Steps
- Isolate and test Ansible-derived rendering before expanding the deterministic Abbey Docs scope.