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

Align cleanup documentation

Browse Source
This commit is contained in:
Eric Rakestraw
2026-05-29 20:46:05 +00:00
parent 448bd1e510
commit a34aec1dd2
2 changed files with 17 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
docs/internal/app-orchestration.md
View File

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

15
docs/internal/state.md
View File

@@ -61,13 +61,14 @@ artifact group. Metadata is stored beside briefing snapshots and links
briefing, data package, preflight, and report paths. Report listing walks briefing, data package, preflight, and report paths. Report listing walks
metadata files under the snapshots directory. metadata files under the snapshots directory.
Prior snapshot lookup reads metadata and selects the latest earlier snapshot Prior snapshot lookup reads metadata through the shared lookup path and selects
whose report ID is compatible according to the current report definition. Daily the latest earlier snapshot whose report ID is compatible according to the
Today and Daily Tomorrow are compatible with each other for the same valid local current report definition. Daily Today and Daily Tomorrow are compatible with
date. 3-Day Outlook compares with prior 3-Day snapshots for the same valid each other for the same valid local date. 3-Day Outlook compares with prior
local date. Weekend Outlook compares with prior Weekend snapshots for the same 3-Day snapshots for the same valid local date. Weekend Outlook compares with
weekend window. Storm Report currently has no prior lookup because its prior Weekend snapshots for the same weekend window. Storm Report currently has
comparison strategy is not searched by the filesystem store. no prior lookup because its comparison strategy is not searched by the
filesystem store.
## Skip And Resume Behavior ## Skip And Resume Behavior