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

- docs route renders without the app shell (own header, back-to-app link,
  theme toggle)
- nav entry renamed to Hilfe (de) / Help (en)
- reference links now case-insensitive (schema/tag slugs)
- handbook rewritten as 17-page user guide with links into the API reference
- release notes v0.8.1 added
This commit is contained in:
opencode
2026-08-03 22:52:14 +02:00
parent 9ceb11e7f9
commit fdf2d741a1
24 changed files with 833 additions and 323 deletions
+57 -43
View File
@@ -1,60 +1,74 @@
---
title: Datenmodell & Felder
order: 8
title: Datenmodell
order: 17
---
# Datenmodell & Felder
# Datenmodell
Dieses Handbuch erklärt die zentralen Objekte von toolr auf verständliche
Weise. Die **vollständige, maschinell generierte Feld-Referenz** findest du in
der [Referenz](/docs/reference/schemas/tool) — dort sind alle Typen, Pflicht-
angaben und Constraints der aktuellen Version dokumentiert.
Dieses Kapitel erklärt die zentralen Datenobjekte von toolr auf Ebene der
Anwendung. Die vollständige, automatisch generierte Referenz aller Felder,
Typen und Constraints findest du in der
[API-Referenz](/docs/reference/schemas/tool).
> Die Referenz ist **versionsgebunden**: Über das Versions-Dropdown oben
> kannst du ältere API-Stände einsehen.
## Tool
## Die wichtigsten Objekte
Das Herzstück: ein im Katalog erfasstes Werkzeug.
### Tool
Ein Tool ist der zentrale Eintrag im Katalog
([Feld-Referenz](/docs/reference/schemas/tool)):
| Feld | Bedeutung |
| Eigenschaft | Beschreibung |
| --- | --- |
| `id` | Eindeutige ID. |
| `name` | Anzeigename. |
| `description` | Kurzbeschreibung. |
| `category` | Kategorie-Zuordnung. |
| `websiteUrl` / `iconUrl` | Offizielle Website bzw. Logo-Link (optional). |
| `createdBy` | Nutzer, der das Tool angelegt hat (optional). |
| `features` / `tags` | Listen von Schlüsselfähigkeiten bzw. Schlagwörtern. |
| `createdAt` / `updatedAt` | Zeitstempel. |
| `deletedAt` / `deletedBy` | Soft-Delete-Informationen (Papierkorb). |
| `id` | Eindeutige Kennung |
| `name` | Anzeigename |
| `description` | Beschreibung (Was macht das Tool?) |
| `category` | Kategorie-Zuordnung |
| `websiteUrl` | Offizielle Website (optional) |
| `iconUrl` | Logo-/Icon-URL (optional) |
| `features` | Liste von Fähigkeiten |
| `tags` | Liste von Schlagwörtern |
| `createdAt` / `updatedAt` | Zeitstempel |
| `createdBy` | Erstellende Person |
| `deletedAt` / `deletedBy` | Soft-Löschung (Papierkorb) |
> **ToolWithStats** erweitert `Tool` um die Aggregatwerte `ratingCount`,
> `avgUsefulness`, `avgUsability` und `avgCombined` (siehe
> [Feld-Referenz](/docs/reference/schemas/toolwithstats)).
Eingabe-Formulare verwenden die abgeleiteten Schemas
[`ToolInput`](/docs/reference/schemas/toolinput) und
[`ToolUpdate`](/docs/reference/schemas/toolupdate).
Aggregierte Ansichten liefert [`ToolWithStats`](/docs/reference/schemas/toolwithstats)
(z. B. mit Durchschnittsbewertung).
### Rating
## Rating (Bewertung)
Eine Bewertung (`Rating`) besteht aus `usefulness` und `usability` (jeweils
15) sowie optionalem Kommentar und Bewerternamen. Details unter
[Bewertungen](/docs/handbook/bewertungen).
Eine einzelne Bewertung zu einem Tool:
### User / AuthUser
- `usefulness` (Nützlichkeit, 15) und `usability` (Bedienbarkeit, 15)
- optional `comment` und ein Anzeigename (`reviewerName`)
- Zeitstempel
- **User** (Admin-Sicht): `id`, `username`, `email`, `role`, `tier`,
`authProvider`, `createdAt` — siehe [Administration](/docs/handbook/administration).
- **AuthUser** (Eigenansicht): `sub`, `email`, `name`, `preferredUsername`,
`role`, `tier`, `entitlements`, `isLocal`.
Eingabe-Schema: [`RatingInput`](/docs/reference/schemas/ratinginput).
### VersionInfo
## User & Auth
`GET /version` liefert `version`, `commitSha`, `buildDate` und
`trashRetentionDays` (siehe [Feld-Referenz](/docs/reference/schemas/versioninfo)).
- [`User`](/docs/reference/schemas/user) — Benutzerkonto mit Rolle (User/Admin)
und Tarif (Free/Premium/Enterprise).
- [`AuthUser`](/docs/reference/schemas/authuser) — das angemeldete Profil
inklusive `entitlements` (verfügbare Features).
- [`UserPreferences`](/docs/reference/schemas/userpreferences) — Ansichts- und
Dichte-Präferenzen sowie die `watchlist` (Liste von Tool-IDs).
## Referenz selber durchsuchen
## Analytics
Nutze das **Suchfeld** in der Doku-Seitenleiste: Es durchsucht Handbuch,
Endpunkt- und Feldbeschreibungen und springt direkt zum passenden Anker.
Die Statistik-Endpunkte liefern aggregierte Daten:
- [`AnalyticsSummary`](/docs/reference/schemas/analyticssummary) — globale
Kennzahlen (Anzahl Tools/Bewertungen, Kategorien, Durchschnitt).
- [`TopToolEntry`](/docs/reference/schemas/TopToolEntry) — ein Eintrag der
Top-Tools.- [`CategoryStats`](/docs/reference/schemas/categorystats) — Tool-Anzahl je
Kategorie.
- [`RatingDistribution`](/docs/reference/schemas/ratingdistribution) —
Punkteverteilung (Nützlichkeit & Bedienbarkeit).
- [`ScoreBucket`](/docs/reference/schemas/scorebucket) — ein Werte-Bucket.
## Weitere
- [`VersionInfo`](/docs/reference/schemas/versioninfo) — Version, Commit-SHA,
Build-Datum und Papierkorb-Aufbewahrung der laufenden Instanz.
- [`AuditLog`](/docs/reference/schemas/auditlog) — ein Protokolleintrag
(Aktion, Entität, Zeitstempel, Akteur, Änderungen).