diff --git a/README.md b/README.md index 0769838..dc547f1 100644 --- a/README.md +++ b/README.md @@ -34,4 +34,8 @@ See [`docs/api.md`](docs/api.md) for the HTTP contract. - [`docs/api.md`](docs/api.md): public HTTP API reference - [`docs/cli.md`](docs/cli.md): command-line usage - [`docs/config.md`](docs/config.md): YAML configuration reference +- [`docs/operations.md`](docs/operations.md): deployment and runtime operations +- [`docs/troubleshooting.md`](docs/troubleshooting.md): symptom-oriented fixes +- [`examples/requests.http`](examples/requests.http): copyable requests for implemented endpoints - [`docs/policy/architecture.md`](docs/policy/architecture.md): development architecture and invariants +- [`docs/policy/development.md`](docs/policy/development.md): contributor workflow and update checklists diff --git a/docs/cli.md b/docs/cli.md index e94824c..937db47 100644 --- a/docs/cli.md +++ b/docs/cli.md @@ -66,3 +66,4 @@ close errors during shutdown are logged. - [`docs/config.md`](config.md): YAML configuration reference - [`docs/api.md`](api.md): public HTTP API reference +- [`docs/operations.md`](operations.md): startup, shutdown, and deployment guidance diff --git a/docs/config.md b/docs/config.md index 1c8f2e3..570366b 100644 --- a/docs/config.md +++ b/docs/config.md @@ -128,3 +128,5 @@ your deployment tooling before starting the service. - [`docs/cli.md`](cli.md): command-line usage and config path precedence - [`docs/api.md`](api.md): HTTP format negotiation and API behavior +- [`docs/operations.md`](operations.md): deployment and runtime guidance +- [`docs/integrations/feedapi.md`](integrations/feedapi.md): feedapi config and runtime boundaries diff --git a/docs/integrations/feedapi.md b/docs/integrations/feedapi.md index 9da06d4..2ce71d2 100644 --- a/docs/integrations/feedapi.md +++ b/docs/integrations/feedapi.md @@ -136,3 +136,5 @@ Before upgrading feedapi: - [`docs/internal/runtime.md`](../internal/runtime.md) - [`docs/internal/http-adapter.md`](../internal/http-adapter.md) - [`docs/api.md`](../api.md) +- [`docs/config.md`](../config.md) +- [`docs/operations.md`](../operations.md) diff --git a/docs/integrations/weatherfeeder-postgres.md b/docs/integrations/weatherfeeder-postgres.md index 0c5fcda..311cec6 100644 --- a/docs/integrations/weatherfeeder-postgres.md +++ b/docs/integrations/weatherfeeder-postgres.md @@ -173,3 +173,4 @@ Before changing weatherfeeder storage or upgrading the weatherfeeder module: - [`docs/internal/postgres-repository.md`](../internal/postgres-repository.md) - [`docs/operations.md`](../operations.md) +- [`docs/troubleshooting.md`](../troubleshooting.md) diff --git a/docs/operations.md b/docs/operations.md index 5eae3c3..a7a11e6 100644 --- a/docs/operations.md +++ b/docs/operations.md @@ -183,3 +183,5 @@ After a database restore or failover: - [`docs/api.md`](api.md): HTTP contract and error envelope - [`docs/config.md`](config.md): configuration reference - [`docs/troubleshooting.md`](troubleshooting.md): symptom-oriented fixes +- [`docs/integrations/feedapi.md`](integrations/feedapi.md): runtime and rendering contracts +- [`docs/integrations/weatherfeeder-postgres.md`](integrations/weatherfeeder-postgres.md): storage contract assumptions diff --git a/docs/policy/architecture.md b/docs/policy/architecture.md index 43c82db..5cd2672 100644 --- a/docs/policy/architecture.md +++ b/docs/policy/architecture.md @@ -170,7 +170,7 @@ Documentation must follow [`docs/policy/documentation.md`](documentation.md). Rules for architecture-related docs: - Current-behavior docs must describe implemented behavior only. -- Planned work, including outlook endpoints, belongs only under `docs/roadmap/` until implemented. +- Unimplemented work belongs only under `docs/roadmap/` until implemented. - Prefer links to canonical docs over repeated reference material. - Update docs in the same change when modifying public routes, query behavior, config behavior, runtime behavior, presenter payloads, or database read assumptions. diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md index 54d40f4..cc6e983 100644 --- a/docs/troubleshooting.md +++ b/docs/troubleshooting.md @@ -273,3 +273,5 @@ Safe fix: repair weatherfeeder ingestion or database routing. Restart - [`docs/api.md`](api.md): endpoint contract, query parameters, errors - [`docs/config.md`](config.md): YAML fields and examples - [`docs/operations.md`](operations.md): runtime and recovery boundaries +- [`docs/integrations/feedapi.md`](integrations/feedapi.md): config, rendering, and error-contract boundaries +- [`docs/integrations/weatherfeeder-postgres.md`](integrations/weatherfeeder-postgres.md): table and freshness assumptions