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

Document Promptkit report generation

Browse Source
This commit is contained in:
Eric Rakestraw
2026-07-31 05:03:02 +00:00
parent 2c68d0a85f
commit b96f40e5ca
39 changed files with 256 additions and 1741 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
docs/operations.md
View File

@@ -44,10 +44,10 @@ continue.
Run a scheduled batch with the same configured collection:
```sh
weatherreporter run morning --out-dir ./reports
weatherreporter run morning --out-dir ./reports --llm-debug-dir /var/tmp/weatherreporter-debug
```
Each batch collects once before it plans reports. Morning runs Today, Tomorrow,
Each batch validates its configured prompt/profile candidates, then collects once before it plans reports. Morning runs Today, Tomorrow,
and every eligible dated Daily Report; evening runs Tomorrow and the same
eligible Daily Reports. Eligible Daily dates begin after tomorrow and require
complete hourly coverage for their entire local civil day. A batch continues
@@ -121,7 +121,7 @@ redacted errors; they do not contain tokens.
## Inspecting Stored Runs
Inspection is read-only: it neither collects weather data nor invokes
Scriptorium or Distributor. Start by finding a RunID:
Promptkit or Distributor. Start by finding a RunID:
```sh
weatherreporter inspect reports --limit 10
@@ -140,6 +140,12 @@ weatherreporter inspect metadata RUN_ID
A missing snapshots directory produces no listed reports. An unknown or empty
RunID is an error; use `inspect reports` to obtain a valid value.
New runs write `weatherreporter.metadata.v2`, including preparation and
execution references once those receipts exist. `inspect metadata` also reads
historic V1 records; their legacy preflight and generated-text-result fields
remain visible for compatibility, but Weatherreporter does not write them for
new runs.
## Recovery
Keep the workspace when a run fails: artifacts reached before the failure
@@ -163,7 +169,7 @@ first response; retain it until the failure is understood.
## Operational Caveats
- Workspace files, generated reports, and Scriptorium stderr can contain
- Workspace files and generated reports can contain
sensitive operational context. Set appropriate filesystem permissions and do
not publish them unintentionally.
- Weatherreporter uses one configured Weather API endpoint and local workspace