Refresh documentation cross-links
All checks were successful
ci/woodpecker/push/build-image Pipeline was successful
All checks were successful
ci/woodpecker/push/build-image Pipeline was successful
This commit is contained in:
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
@@ -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
|
||||
|
||||
Reference in New Issue
Block a user