Files

T

opencode 3bb4598d04 feat(docs): version-based docs, correct Gitea tag links, form guide help

- each release now carries a full docs snapshot (reference + handbook)
  under docs/releases/<v>/; the docs frontend loads a version's snapshot
  for /docs/vX.Y.Z/* and shows the handbook/reference of that version
- version dropdown navigates to /docs/<version> (docs home) instead of
  the release notes page; old /docs/vX.Y.Z redirect removed
- generator: --snapshot writes handbook + reference; build copies
  versioned snapshots (last 7 versions) into /docs/versions/<v>/
- fix Gitea tag links: /admin/tool-evaluator/tags/<v> was 404, correct
  URL is /releases/tag/<v>
- add GuideHelp button to forms/pages linking to the matching handbook
  guide (rating, tool add/edit, costs, compare, watchlist, analytics)

2026-08-04 07:31:47 +02:00

handbook

feat(docs): standalone docs page, Hilfe nav entry, rewritten user guide

2026-08-03 22:52:14 +02:00

releases

feat(docs): version-based docs, correct Gitea tag links, form guide help

2026-08-04 07:31:47 +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.