milestone 13: restructure docs to diataxis, tutorial, every command executed

2026-08-02 18:02:58 +02:00
parent 35f23240e7
commit 16c9de2414
26 changed files with 3627 additions and 901 deletions
@@ -233,7 +233,7 @@ src/

 web/                     # Vite + React + TS + Tailwind + TanStack
 vendor/                  # sqlite3 amalgamation, mbedtls (pinned)
-docs/                    # operator/ architecture/ config-reference/ api/
+docs/                    # tutorial/ how-to/ reference/ explanation/ (Diátaxis)
 tests/                   # dns/ integration/ fuzz/
 ```

@@ -550,7 +550,7 @@ Scalars in `settings(key, value)`; ordered/structured items in dedicated tables.

 ### 13.2 OpenAPI

-Hand-maintained `openapi.yaml`, served + rendered into `docs/api/`. CI contract tests spin up a seeded server, hit every documented endpoint, and validate bodies/status/auth against the schema. Drift fails CI.
+Hand-maintained `openapi.yaml`, served at `GET /api/openapi.yaml` and mirrored by hand in `docs/reference/api.md`. No renderer is vendored. Two drift guards fail the build instead: `src/web/openapi.zig` asserts every served route appears in the spec, and `src/docs_drift_test.zig` asserts every served route has its own table row in the reference page.

 ---