Files

T

opencode 6eb3dfd8f9 docs: cut to v0.9.0 with unified .de/.en naming

- Remove all prior release notes and version snapshots (v0.6.0-v0.8.6)
- Rename handbook to *.de.md; keep *.en.md
- New release notes v0.9.0.de.md/.en.md with v0.9.0 snapshot
- generate-docs.mjs: .de/.en convention incl. search index and en-fallback
- docs.tsx: release fallback now uses version.de.md
- Wording: neutral tagline, anonymous user, no gender forms
- Add docs/examples/import-tools.yaml and link from administration docs

2026-08-05 00:13:41 +02:00

examples

docs: cut to v0.9.0 with unified .de/.en naming

2026-08-05 00:13:41 +02:00

handbook

docs: cut to v0.9.0 with unified .de/.en naming

2026-08-05 00:13:41 +02:00

releases

docs: cut to v0.9.0 with unified .de/.en naming

2026-08-05 00:13:41 +02:00

dependency-policy.md

chore(deps): upgrade all dependencies to latest and pin exact

2026-08-03 12:56:00 +02:00

README.md

feat(docs): mkdocs-style documentation site served at /docs

2026-08-03 22:15:54 +02:00

README.md

Dokumentation (Handbuch, API-Referenz, Release-Notes)

Die App zeigt unter /docs eine MkDocs-artige Doku-Seite mit drei Bereichen:

Handbuch (docs/handbook/*.md) — von Hand gepflegte Anleitungen
API-Referenz (lib/api-spec/openapi.yaml) — automatisch generierte Endpunkte & Datenfelder (Schema-Detailseiten mit Feld-Ankern; die ?-Icons in Formularen verlinken auf diese Felder)
Release-Notes (docs/releases/vX.Y.Z.md) — pro Release

Struktur

docs/handbook/ — Handbuch-Seiten mit Frontmatter (title, order)
docs/releases/TEMPLATE.md — Vorlage für neue Releases
docs/releases/vX.Y.Z.md — Notes pro Release
docs/releases/vX.Y.Z/reference.json — API-Snapshot der jeweiligen Version

Generator

scripts/src/generate-docs.mjs wird beim Frontend-Build (und dev) automatisch ausgeführt und schreibt die Artefakte nach artifacts/toolrate/public/docs/:

reference.json (aktuelle API), search.json (Suchindex), index.json (Releases), handbook/*.md + handbook/index.json
releases/vX.Y.Z.md und versions/vX.Y.Z.json (API-Snapshots alter Versionen)

Manuell aufrufbar:

node scripts/src/generate-docs.mjs                  # Build-Modus
node scripts/src/generate-docs.mjs --snapshot v0.9.0   # Snapshot für neue Version

Workflow beim Release

Version taggen wie bisher (git tag vX.Y.Z, CI baut und deployed).
docs/releases/vX.Y.Z.md anlegen — Vorlage aus TEMPLATE.md kopieren, Entwurf aus der Git-Historie ableiten:
```
git log --oneline vX.Y.Z-1..vX.Y.Z
```
(API-Delta anhand lib/api-spec/openapi.yaml prüfen.)
API-Snapshot erzeugen: node scripts/src/generate-docs.mjs --snapshot vX.Y.Z erzeugt docs/releases/vX.Y.Z/reference.json.
Committen & pushen. Der Build kopiert die Dokumentation automatisch nach artifacts/toolrate/public/docs/ und generiert index.json.

Hinweis: Alle Dateien unter artifacts/toolrate/public/docs/ sind Build-Artefakte und werden bei jedem Build neu generiert — nicht von Hand bearbeiten. Einzige Quellen sind docs/handbook/, docs/releases/ und lib/api-spec/openapi.yaml.