3de59ccaaf
Build & Push Docker Image / build (push) Successful in 2m33s
- translate remaining pages/components (admin, analytics, redundancy, trash, compare, browse, watchlist, admin tools tab, category combobox, theme toggle, tool preview card, tool-new/edit) to t() calls - locales: 453 keys each, parity verified - docs: bilingual handbook + release notes via *.en.md variants, language-aware docs.tsx (markdown paths, nav titles, search index), LanguageSwitcher in docs header - generate-docs: emit per-locale handbook/release/search output, localized index.json fields (fileEn/titleEn), en-aware snapshots
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 Releasesdocs/releases/vX.Y.Z.md— Notes pro Releasedocs/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.jsonreleases/vX.Y.Z.mdundversions/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.mdanlegen — Vorlage ausTEMPLATE.mdkopieren, Entwurf aus der Git-Historie ableiten:(API-Delta anhandgit log --oneline vX.Y.Z-1..vX.Y.Zlib/api-spec/openapi.yamlprüfen.)- API-Snapshot erzeugen:
node scripts/src/generate-docs.mjs --snapshot vX.Y.Zerzeugtdocs/releases/vX.Y.Z/reference.json. - Committen & pushen. Der Build kopiert die Dokumentation automatisch nach
artifacts/toolrate/public/docs/und generiertindex.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 sinddocs/handbook/,docs/releases/undlib/api-spec/openapi.yaml.