Align cleanup documentation

This commit is contained in:
2026-05-29 20:46:05 +00:00
parent 448bd1e510
commit a34aec1dd2
2 changed files with 17 additions and 12 deletions

View File

@@ -4,9 +4,10 @@ This document describes the implemented workflow coordinator in `internal/app`.
## Purpose
`internal/app` coordinates top-level use cases: generating one report, running
morning or evening batches, building inspectable briefing artifacts, fetching
weather bundles, and reading existing artifacts for inspection.
`internal/app` coordinates top-level use cases: generating one report through
the shared report-generation path, running morning or evening batches, building
inspectable briefing artifacts, fetching weather bundles, and reading existing
artifacts for inspection.
## Inputs And Outputs
@@ -21,8 +22,9 @@ Inputs:
Outputs:
- report results with briefing, data package, preflight, report, metadata,
prior snapshot, Recent Changes, and Scriptorium results
- report results for generated report definitions with briefing, data package,
preflight, report, metadata, prior snapshot, Recent Changes, and Scriptorium
results
- batch summaries with per-report status and artifact paths
- inspection JSON values for reports, metadata, briefings, data packages, prior
snapshots, and source provenance
@@ -84,6 +86,8 @@ Inspect:
## Invariants
- Report behavior is resolved through `internal/report`.
- Generated reports use the same app request and result types regardless of
report ID.
- Render preflight precedes Scriptorium report generation.
- Recent Changes are computed from structured briefing snapshots.
- Metadata links artifacts produced for a run.