eric/audita
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 2 Wiki Activity

Complete Phase 19 Go rollout documentation

Browse Source
This commit is contained in:
Eric Rakestraw
2026-05-12 13:46:14 +00:00
parent 68e2d9b549
commit fb59cb21b9
5 changed files with 345 additions and 65 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
docs/architecture.md
View File

@@ -2,10 +2,10 @@
## Scope and intent
This document describes:
- the current implemented Go architecture; and
- the intended final architecture for later rewrite phases.
- the implemented Go architecture used in production today; and
- historical rewrite-phase context that explains how the architecture was delivered.
Status labels are explicit so future engineers and LLM agents do not assume unimplemented behavior exists.
Status labels are explicit so future engineers and LLM agents do not infer missing behavior that is not actually missing.
## Current implementation status
Implemented today:
@@ -42,9 +42,6 @@ Implemented today:
- Explicit runtime support for `--modules homophones` through the production runner path.
- Explicit runtime support for `--modules spoken_word` through the production runner path.
Not implemented in CLI runtime path today:
- Rollout and Python retirement work (Phase 19).
Current reality:
- all production modules exist and are wired into the default runtime path.
- a normal `audita process` run without `--modules` now executes the full sequence:
@@ -66,7 +63,7 @@ Phase sequencing note:
- Phase 16 default full pipeline integration is complete;
- Phase 17 parity fixture suite is complete;
- Phase 18 operational hardening and subprocess integration are complete;
- next recommended phase is Phase 19 (documentation, rollout, and Python retirement).
- Phase 19 documentation/rollout completion is complete.
## Actual Go package layout
@@ -468,8 +465,8 @@ Current runtime note:
- default non-explicit runs usually have no module-level skipped corrections, so `auto` commonly removes clean successful run directories.
- explicit grammar/glossary/homophones/spoken_word runs can produce validator rejections and application skips, which are reflected in reports and retention input.
Intentionally deferred to module/LLM phases:
- real domain proposal prompts and production module implementations remain tied to later module phases.
Phase note:
- Earlier-phase documentation deferred module and LLM prompt work; those deferred items were completed by Phases 12-16.
## Current tests and quality posture
Implemented tests currently cover:
@@ -507,8 +504,9 @@ The runtime now includes hardened subprocess behavior for parent-process callers
Operational caller guidance is documented in [`docs/subprocess-operations.md`](docs/subprocess-operations.md).
## Remaining work (Phase 19)
Remaining rewrite work is documentation/rollout/retirement-oriented:
- repository-level rollout documentation and migration guidance;
- Python retirement/archival decisions and related documentation cleanup;
- final release-facing communication of Go-primary operational guidance.
## Final status (Phase 19 complete)
- Go Audita is the active implementation.
- Default full module-sequence runtime is implemented and tested.
- Parity fixtures and operational hardening coverage are in place.
- Python is preserved as a legacy/reference implementation in `python/` and is no longer the primary operational path.
- Migration and rollout guidance is documented in [`docs/migration-from-python.md`](docs/migration-from-python.md).