Clean up documentation consistency
All checks were successful
ci/woodpecker/push/build-image Pipeline was successful

This commit is contained in:
2026-06-10 20:28:41 +00:00
parent ec115ba152
commit 002f9d0ba6
9 changed files with 21 additions and 21 deletions

View File

@@ -101,8 +101,8 @@ Payload type: `WeatherForecastRun`.
| `locationId` | string | no | Provider location identifier. |
| `locationName` | string | no | Human location name. |
| `issuedAt` | timestamp | yes | When the forecast run was generated or issued. |
| `updatedAt` | timestamp | no | Later provider update time. |
| `product` | string | yes | `hourly`, `narrative`, or `daily`. |
| `updatedAt` | timestamp | no | Subsequent provider update time. |
| `product` | string | yes | Current emitted values are `hourly` and `narrative`. |
| `latitude` | number | no | Degrees. |
| `longitude` | number | no | Degrees. |
| `elevationMeters` | number | no | Meters. |
@@ -145,7 +145,7 @@ Payload type: `WeatherForecastDiscussion`.
| `officeName` | string | no | Office name. |
| `product` | string | yes | Current value is `afd`. |
| `issuedAt` | timestamp | yes | Bulletin issue time. |
| `updatedAt` | timestamp | no | Later update time. |
| `updatedAt` | timestamp | no | Subsequent update time. |
| `keyMessages` | array of strings | no | Extracted key messages. |
| `shortTerm` | object | no | Short-term section. |
| `longTerm` | object | no | Long-term section. |

View File

@@ -62,7 +62,7 @@ and before each interval tick. If no jitter is configured in code, feedkit uses
`min(every/10, 30s)`, capped at half the interval.
Poll failures are logged and do not stop the daemon. A failed poll emits no
events for that source until a later poll succeeds.
events for that source until a subsequent poll succeeds.
## Conditional HTTP Fetches

View File

@@ -2,11 +2,11 @@
## Purpose
This document defines `weatherfeeder`'s development architecture and invariants for maintainers and LLM coding agents. It describes how the implemented system is built and how future changes should preserve its boundaries.
This document defines `weatherfeeder`'s development architecture and invariants for maintainers and LLM coding agents. It describes how the implemented system is built and how subsequent changes should preserve its boundaries.
This is an inward-facing policy document. User-facing wire contracts belong in
[`docs/integrations/events.md`](../integrations/events.md), and future work
belongs under [`docs/roadmap/`](../roadmap/).
[`docs/integrations/events.md`](../integrations/events.md), and roadmap items
belong under [`docs/roadmap/`](../roadmap/).
## Project Shape
@@ -57,9 +57,9 @@ Tests and examples:
- The sample `cmd/weatherfeeder/config.yml` is executable test input and is load-tested.
- Tests should keep exercising package contracts directly rather than relying only on full-daemon execution.
## Modules or Stages
## Modules Or Processing Steps
The implemented processing stages are source polling, normalization, dedupe, and sink dispatch.
The implemented processing steps are source polling, normalization, dedupe, and sink dispatch.
Source contract:

View File

@@ -28,8 +28,8 @@ Diagnostic: inspect the line and field in the error. Feedkit uses strict YAML
field decoding for config struct fields.
Safe fix: correct the YAML and compare the shape with
[configuration](config.md). Driver-specific `params` keys are validated later by
their source or sink constructors.
[configuration](config.md). Driver-specific `params` keys are validated by their
source or sink constructors.
## `config validation failed`