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

Add scriptorium and weatherapi integratino docs

Browse Source
This commit is contained in:
Eric Rakestraw
2026-05-29 10:24:22 -05:00
parent d998791e20
commit 577b42e243
3 changed files with 479 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
docs/roadmap/initial.md
View File

@@ -115,6 +115,11 @@ Implement configuration loading and a stable command shape before integrating ex
Fetch normalized weather data from the internal weather API and represent it as a stable forecast bundle inside the application.
### Key References
- `docs/integrations/weatherapi.md` describes the weatherapi public API
- The local API endpoint is available at `https://weather.api.rakestrawhome.com/` and will return live data
### Packages Introduced or Expanded
- `internal/adapters/weatherapi`
@@ -126,11 +131,11 @@ Fetch normalized weather data from the internal weather API and represent it as
1. Define the internal `forecast.Bundle` type.
2. Define source substructures for:
- Hourly forecast data.
- Daily forecast data.
- Daily forecast data (NOTE: not yet implemented upstream in weatherapi, so this can remain a stub in the initial implementation).
- NWS narrative forecast periods.
- NWS alerts.
- NWS forecast discussion.
- NWS weather story.
- NWS weather story (NOTE: not yet implemented upstream in weatherapi, so this can remain a stub in the initial implementation).
3. Implement the weather API client.
4. Add context-aware HTTP calls and timeouts.
5. Add actionable errors for failed API calls and decode failures.
@@ -174,7 +179,7 @@ Implement deterministic forecast processing needed by the Daily Report.
4. Compute daypart summaries:
- Temperature range.
- Apparent-temperature range, if available.
- Max precipitation probability.
- Max precipitation probability and associated hour.
- Peak wind speed.
- Peak wind gust.
- Dominant or notable conditions.
@@ -357,6 +362,9 @@ Convert a briefing package into the structured variable payload expected by `scr
Invoke `scriptorium` as a subprocess and produce the first rendered Markdown report.
### Key References
- `docs/integrations/scriptorium.md` describes the CLI contract for running `scriptorium` as a subprocess.
### Packages Introduced or Expanded
- `internal/adapters/scriptorium`