Files
weatherreporter/docs/roadmap/future.md

144 lines
4.9 KiB
Markdown
Raw Normal View History

2026-05-29 20:02:56 +00:00
# Future Roadmap
2026-07-31 01:39:33 +00:00
This roadmap contains future work only. Each section identifies its planning
status; current behavior is documented outside `docs/roadmap/`.
2026-05-29 20:02:56 +00:00
## Automatic Storm Monitoring
2026-05-29 20:02:56 +00:00
2026-07-31 01:39:33 +00:00
Status: Proposed and unimplemented.
2026-05-29 20:02:56 +00:00
Storm reporting, whether manual or automatic, is unimplemented.
2026-06-15 13:00:59 +00:00
Possible direction:
1. Detect candidate storm events from alerts, forecast discussion, weather
story context, hourly thresholds, and material forecast changes.
2. Evaluate candidates through Promptkit or another narrow evaluator adapter.
2026-06-15 13:00:59 +00:00
3. Persist storm lifecycle state.
4. Generate or update a storm report only when a meaningful event is present.
2026-06-15 13:00:59 +00:00
5. Suppress ordinary low-impact thunder or rain chances.
2026-05-29 20:02:56 +00:00
Possible lifecycle states:
- `none`
- `monitoring`
- `active_report`
- `escalated`
- `deescalating`
- `resolved`
2026-06-15 13:00:59 +00:00
Before implementation, the design must preserve scheduled report behavior,
inspectable evaluator failures, and fixture coverage for deterministic
candidate detection.
2026-05-29 20:02:56 +00:00
2026-06-15 13:00:59 +00:00
## Future Report Types
2026-05-29 20:02:56 +00:00
2026-07-31 01:39:33 +00:00
Status: Proposed and unimplemented.
Possible future report types:
2026-05-29 20:02:56 +00:00
2026-06-15 13:00:59 +00:00
- a short-fuse planning report distinct from the implemented Hourly Report, if
a separate product is needed
- event-specific reports with stable event IDs
- storm review or yesterday-style reports using historical observations
- archive-focused report variants if generated report history becomes a
2026-06-15 13:00:59 +00:00
first-class product
2026-07-31 01:39:33 +00:00
New reports should preserve the boundaries documented in the [report registry
internals](../internal/report-registry.md).
2026-06-15 13:00:59 +00:00
## Future Modules
2026-07-31 01:39:33 +00:00
Status: Proposed and unimplemented.
Possible future modules:
2026-06-15 13:00:59 +00:00
- `hourly_table` for compact valid-period hourly facts
- `forecast_delta` if a separate stanza is useful beyond current Recent
2026-06-15 13:00:59 +00:00
Changes
- `weekend_planning` if weekend-specific planning guidance needs a dedicated
2026-06-15 13:00:59 +00:00
deterministic stanza
- `storm_window_summary` if manual or automatic storm reports need a dedicated
2026-06-15 13:00:59 +00:00
prompt-facing storm-window module
- separate AFD section aliases, such as `afd_key_messages`,
`afd_short_term_text`, and `afd_long_term_text`, if separate stanzas prove
2026-06-15 13:00:59 +00:00
more useful than `area_forecast_discussion.options.sections`
- SPC, radar, QPF, snow/rain total, or historical-observation modules once
2026-06-15 13:00:59 +00:00
upstream sources and report requirements exist
QPF fields such as `measurable_qpf_total_in` and `max_hourly_qpf_in` should
remain omitted until a real upstream quantitative precipitation source is
represented in `CollectedFacts`.
2026-07-31 01:39:33 +00:00
Future module work should preserve the boundaries documented in [fact
contracts](../internal/facts.md), [module internals](../internal/module.md), and
[briefing internals](../internal/briefing.md):
- keep upstream collection in app orchestration
- keep upstream collection out of modules
2026-06-15 13:00:59 +00:00
- keep broad reusable calculations in `DerivedFacts`
- keep prompt-facing field shape inside module builders
- use typed options for configurable module behavior
- keep module snapshots structured and deterministic for Recent Changes
2026-05-29 18:27:34 -05:00
## Distributor Notification Enhancements
2026-06-07 23:50:55 +00:00
2026-07-31 01:39:33 +00:00
Status: Proposed and unimplemented.
Single-report and batch Distributor notification are implemented. Current
behavior is documented in the [Distributor adapter guide](../internal/distributor-adapter.md),
[Distributor integration guides](../integrations/distributor/), and
[operations guide](../operations.md). The following enhancements remain
unimplemented:
2026-06-07 23:50:55 +00:00
2026-06-15 13:00:59 +00:00
- `failure_policy: warn`
- uploading metadata, module snapshots, data packages, or preflight artifacts
- durable upload retry queues
- distributor-specific CLI flags
- distributor workspace scanning
- destination routing, Markdown-to-HTML transformation, public URLs, or nginx
layout inside weatherreporter
2026-06-07 23:50:55 +00:00
2026-06-15 13:00:59 +00:00
Any distributor enhancement should preserve the adapter boundary:
2026-06-07 23:50:55 +00:00
weatherreporter selects explicit generated files and submits source bundles,
while distributor owns destination routing and publication behavior.
## Alternate Runtime Integrations
2026-07-31 01:39:33 +00:00
Status: Proposed and unimplemented.
These ideas remain unimplemented:
2026-06-15 13:00:59 +00:00
- native LLM client inside `weatherreporter`
- database-backed state
- public HTTP API
- multi-location selection
- daemon mode
- multi-user authorization
- plugin system
- dynamic module loading
- user-defined module code
- YAML-defined module schemas
- module-owned Weather API fetching
Each item needs its own design note before implementation. Non-roadmap docs
must not describe these as available behavior.
2026-06-15 13:00:59 +00:00
## Deferred Refactors
2026-07-31 01:39:33 +00:00
Status: Deferred.
2026-06-15 13:00:59 +00:00
These refactors should remain deferred until new requirements or recurring
maintenance costs make the added abstraction worthwhile:
- broad briefing weather-signal consolidation
- generic workflow engine
- Cobra migration
- manifest, resume, or progress system
- global test helper package
- logging subsystem
2026-05-29 18:27:34 -05:00
Any future implementation should preserve the existing public CLI, artifact
paths, report identities, module boundaries, and adapter boundaries unless a
separate roadmap explicitly changes them.