Refresh documentation and policies and simplify releases

This commit is contained in:
2026-09-23 15:03:20 +00:00
parent 588ca36dfc
commit e8b8fbd509
36 changed files with 2143 additions and 2261 deletions

View File

@@ -2,17 +2,15 @@
## Scope
This document is the internal architecture entry point for developers and coding agents.
It summarizes:
- package boundaries;
- the main `process` execution path;
- where to add new code safely.
This document owns the implemented component map. For normative boundaries, see
[architecture policy](../policy/architecture.md); for task-specific reading and
baseline commands, see the [contributor guide](../development.md).
## Package Map
CLI and command orchestration:
- `internal/cli`
Executable and command orchestration:
- `cmd/audita`: executable entry point.
- `internal/cli`: argument parsing, config commands, streams, filesystem wiring, and process orchestration.
Core deterministic components:
- `internal/core/config`
@@ -43,43 +41,47 @@ Domain implementations:
- `internal/validators/*`
- `internal/prompts`
Supporting areas:
- `docs/`: canonical documentation.
- `examples/`: maintained copyable inputs and configuration.
## Current Scope
Runtime state is held in memory plus per-run diagnostics artifacts. Audita does
not currently implement a plugin framework, generic workflow engine,
resume/checkpoint/manifest system, remote storage, or multi-process service mode.
Its provider adapter is OpenAI-compatible HTTP behind the structured LLM client
contract. These are current implementation boundaries, not bans on future work.
## Main Execution Path (`audita process`)
High-level flow:
1. CLI loads effective config and validates CLI requirements.
2. Run directory is created and invocation/effective config artifacts are written.
3. Transcript/glossary files are loaded and parsed.
4. Transcript is normalized and chunked.
5. `runner.Run` executes configured module instances.
6. Proposals are validated, applied deterministically, and serialized in selected output schema.
7. Process report, utilization diagnostics, correction ledger, and retention decisions are finalized.
The CLI prepares input and configuration, invokes the runner, and writes results.
The [pipeline](pipeline.md) owns detailed state transitions; the
[operations guide](../operations.md) owns the operator workflow and physical
artifact lifecycle.
## Boundary Summary
## Component Responsibilities
- `internal/core/*` owns deterministic, reusable logic and persistence-independent rules.
- `internal/framework/*` owns orchestration contracts and reusable runtime plumbing.
- `internal/modules/*` owns module-specific proposal behavior and prompt usage.
- `internal/validators/*` owns validator composition and built-in chain assembly.
- `internal/prompts` owns embedded prompt assets and metadata registry.
Core components implement configuration defaults/loading/validation/redaction,
transcript and glossary schemas, normalization and chunking, output encoding,
diagnostics artifact helpers, and public report structures.
## Where To Add New Code
Framework components implement module and validator contracts, proposal
generation and application, prompt context, runner orchestration, LLM scheduling
and transport, response schemas, and process-report/correction-ledger assembly.
Domain packages provide correction modules, built-in validator chains and
execution metadata, and embedded prompt assets.
Add config fields:
- `internal/core/config`
These describe the implementation; dependency and ownership requirements belong
to the [architecture policy](../policy/architecture.md#ownership-and-dependency-direction).
Add module behavior:
- one package under `internal/modules/<module_key>`
- registration/wiring through `internal/framework/modules` and config module list
## Change Recipes
Add validators:
- implementation under `internal/validators/<validator_key>`
- registry/chain wiring in `internal/validators`
Add runtime orchestration behavior:
- `internal/framework/*` (runner/proposal/validator/LLM plumbing)
Add CLI surface:
- `internal/cli`
- [Configuration, CLI, and example changes](cli-config.md)
- [Module changes](modules.md#changing-modules)
- [Validator changes](validators.md#changing-validators)
- Runtime orchestration changes: use [pipeline](pipeline.md), [LLM runtime](llm-runtime.md),
or [diagnostics/reporting](diagnostics-reporting.md) and their test references.
## Related Internal Docs