Document SPC convective outlook behavior

This commit is contained in:
2026-06-12 15:17:06 +00:00
parent d7a72f8581
commit 3482551360
6 changed files with 114 additions and 9 deletions

View File

@@ -49,7 +49,9 @@ unknown or unimplemented module IDs fail validation instead of being skipped.
## Options
Most modules use an empty options struct. `area_forecast_discussion` accepts:
Most modules use an empty options struct, including
`spc_convective_outlooks` and `spc_convective_discussion`.
`area_forecast_discussion` accepts:
```yaml
sections:
@@ -63,6 +65,28 @@ An omitted or empty `sections` list includes all available discussion sections.
Invalid option shapes fail during config normalization or composition
validation.
## SPC Convective Module Outputs
`spc_convective_outlooks` emits a prompt-facing risk-product stanza with:
- `checked`
- `as_of`
- `issued_at`
- `location_id`
- `location_name`
- `outlook_count`
- `outlooks`
Each outlook entry may include `day`, `outlook_type`, `label`, `label_text`,
`severity_rank`, `valid_start`, `valid_end`, `issued_at`, `expires_at`,
`contains_location`, `source_url`, and `image_url`. It omits GeoJSON geometry.
`spc_convective_discussion` emits a narrative stanza only when a retained
report-period outlook has severity rank `3` or higher and matching discussion
text is available. Its output includes `included_because` and `discussions`;
each discussion may include `day`, `headline`, `summary`, `discussion`, and
`updated_at`.
## Boundaries
- This package owns module identifiers, config item envelopes, output