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

Refine rewrite documentation accuracy

Browse Source
This commit is contained in:
Eric Rakestraw
2026-05-11 08:50:33 -05:00
parent 73249b63d8
commit c1193e3450
2 changed files with 15 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
docs/architecture.md
View File

@@ -104,6 +104,7 @@ Important behavior details:
- No module execution occurs despite `--modules` config support.
- No LLM calls occur.
- Success path is generally quiet on stderr.
- Source IDs are preserved into a canonical transcript before normalization; normalization then reassigns output IDs sequentially from `1`.
## Implemented data contracts
@@ -206,6 +207,19 @@ Retention modes implemented in `ApplyRetention`:
- `auto`: currently same as `never` for successful runs
- failed runs are always retained
## Current tests and quality posture
Implemented tests currently cover:
- CLI argument handling and behavior (`internal/cli/run_test.go`)
- subprocess stdout/stderr and exit-code behavior (`cmd/audita/main_integration_test.go`)
- config/env/override validation (`internal/core/config/*_test.go`)
- transcript and glossary schema validation (`internal/core/schema/*_test.go`)
- deterministic normalization (`internal/core/normalization/*_test.go`)
- deterministic chunking and summaries (`internal/core/chunking/*_test.go`)
- proposal preview/apply semantics (`internal/framework/proposals/*_test.go`)
- contracts/foundation composition tests (`internal/framework/contracts/*_test.go`)
Not covered yet (because not implemented): end-to-end module runner behavior, validator runtime flow, and real LLM integration.
## Intended final architecture (not yet implemented)
The intended end-state still matches the rewrite plan:
- sequential module pipeline over a mutable working transcript

1
docs/rewrite-notes.md
View File

@@ -12,6 +12,7 @@ Implemented:
- Per-run diagnostics directory plus normalization/chunking artifacts.
- Minimal process report output (`--report-json` and run-dir `report.json`).
- Framework foundation packages for contracts and proposal preview/apply semantics.
- Broad deterministic and CLI/subprocess test coverage for the implemented phases (`go test ./...`).
Not yet implemented in runtime pipeline:
- Module runner orchestration.