Clarify module package documentation

This commit is contained in:
2026-06-09 21:42:38 +00:00
parent d665049f05
commit 1ddd88231a
12 changed files with 197 additions and 114 deletions

View File

@@ -7,8 +7,8 @@ membership, output naming, artifact grouping, and comparison declarations in
## Purpose
`internal/report` is the canonical source for report definitions. App, state,
module building, and CLI wiring consume resolved definitions instead of owning report
identity policy themselves.
module building, and CLI wiring consume resolved definitions instead of owning
report identity policy themselves.
## Definition Fields
@@ -25,7 +25,7 @@ Each report definition declares:
- morning or evening batch membership
- default ordered module composition
## Implemented Reports
## Reports
| Report | ID | Prompt | Artifact group | Batch copy | Prior compatibility |
| --- | --- | --- | --- | --- | --- |
@@ -35,7 +35,7 @@ Each report definition declares:
| Weekend Outlook | `weekend` | `weather.weekend_outlook` | `weekend` | `weekend.md` | Weekend Outlook |
| Storm Report | `storm` | `weather.storm_report` | `storm` | `storm.md` | Storm Report |
All implemented report definitions are eligible for generation.
All report definitions are eligible for generation.
## Valid Periods
@@ -55,8 +55,8 @@ must be after start time.
## Boundaries
`internal/report` defines report metadata and time coverage. It does not fetch
weather data, build module values, compare snapshot contents, write state, parse CLI
flags, or invoke Scriptorium.
weather data, build module values, compare snapshot contents, write state,
parse CLI flags, or invoke Scriptorium.
The CLI owns public command names. The app maps those command names to report
IDs, then uses the registry for report policy.