diff --git a/docs/integrations/subprocess.md b/docs/integrations/subprocess.md index 4796d37..bfc3518 100644 --- a/docs/integrations/subprocess.md +++ b/docs/integrations/subprocess.md @@ -29,10 +29,11 @@ Interpret the exit result according to the [CLI output and exit contract](../cli.md#inspection-and-outcomes). Consume transcript/report data through the [output-file contract](output-files.md), and treat stderr as human-readable detail. -The three reports may be absent after early configuration or destination -failures. After initialization, failed reports can describe invalid input or -partial processing and use the same selected report directory as successful -runs. Exit `0` can include recoverable model errors and applied +Audita loads configuration and parses the input transcript before report +initialization. Early destination failures can also leave no reports. After +initialization, failed reports can describe partial processing or output +failures and use the same report directory as successful runs. +Exit `0` can include recoverable model errors and applied corrections; inspect `errors.yml` and `recoveries.yml` for those outcomes. A transcript may have been written before a later required report failure, so the file alone does not prove completion. diff --git a/docs/migrations/v3.md b/docs/migrations/v3.md index 1ccb158..061731c 100644 --- a/docs/migrations/v3.md +++ b/docs/migrations/v3.md @@ -1,21 +1,25 @@ # Migrating to application configuration v3 -Audita v3 is a hard cutover. Move application settings to `version: 3` and use -[the configuration reference](../config.md) and [maintained examples](../../examples/) -to construct the new files. The previous configuration and standalone glossary -formats are not loaded by the new processing path. +Audita 3.1.x uses application configuration schema v2. For the cutover to schema +v3, set `version: 3` in the application file and move glossary entries into +configuration. Use the [configuration reference](../config.md) and +[maintained examples](../../examples/) for the new formats. - Replace `pipeline.modules` with ordered `pipeline.stages` records containing `module` and any per-entry overrides. An explicit empty list runs normalization. - Define named `glossary_collections` in configuration or its companion imports; - select them using `glossaries` and `protected_terms`. Remove `--glossary` and - `--modules` from invocations. + select them using `glossaries` and `protected_terms`. Rename each legacy + entry's `summary` to `description` to preserve its prompt context. Remove + `--glossary` and `--modules` from invocations. - Move profiles and backends out of the application configuration and retired `profiles_dir` layout into PromptKit resources. Use its current list records, IDs, credential sources, and backend admission settings. Select proposal and validation profiles in application `llm` settings. - Use the shared `--debug` flag for capture; `diagnostics.work_dir` remains the parent directory. Review report and output destinations before running. +- Completion counts are hidden by default. Use `--verbose` to see them on + stderr, including when ordinary reports are disabled. `--debug` also shows + counts unless followed by `--quiet`. See [CLI reporting](../cli.md#processing). Inspect configuration and resources before processing, then try a controlled small transcript. Processing preflight checks every glossary correction and diff --git a/docs/releases/v3.0.0.md b/docs/releases/v3.0.0.md index 11d38c2..2a59eb3 100644 --- a/docs/releases/v3.0.0.md +++ b/docs/releases/v3.0.0.md @@ -47,8 +47,8 @@ profile files require migration from the v2 release format. `audita config validate --config /path/to/config.yml`, including any selected testing overlay. Application configuration continues to use `version: 2`. -The [configuration reference](../config.md#promptkit-profiles-and-operator-prompts) -contains the migrated format and presence rules. Start from the maintained +The [v3.0.0 configuration reference](https://gitea.maximumdirect.net/eric/audita/src/tag/v3.0.0/docs/config.md#promptkit-profiles-and-operator-prompts) +contains the migrated format and presence rules. Start from the [local](https://gitea.maximumdirect.net/eric/audita/src/tag/v3.0.0/examples/minimal-config.yml), [service](https://gitea.maximumdirect.net/eric/audita/src/tag/v3.0.0/examples/production-config.yml), or [application inheritance](https://gitea.maximumdirect.net/eric/audita/src/tag/v3.0.0/examples/configkit-inheritance.yml) examples. diff --git a/docs/roadmap/remediation.md b/docs/roadmap/remediation.md index 0825b90..213b177 100644 --- a/docs/roadmap/remediation.md +++ b/docs/roadmap/remediation.md @@ -283,6 +283,8 @@ diagnostics with an active consumer or a documented requirement. ## R8 — P3: Clarify the Configuration Cutover and Preflight Documentation +**Status:** Completed. Migration guidance now distinguishes the application schema from the executable version and explains glossary descriptions and completion counts. Subprocess guidance reflects early transcript parsing, and the v3.0.0 reference points to the tagged format. + **Category** Documentation divergence in Stage 14.