forked from fa/breadcrumb-the-shire
4.1 KiB
4.1 KiB
Dokumentation
Letzte Aktualisierung: 2026-03-06
Diese Dokumentation ist nach dem Diataxis-Modell in vier Quadranten gegliedert: Tutorials zum Lernen, How-to Guides zum Nachschlagen von Aufgaben, Explanation zum Verstehen und Reference zum Nachschlagen von Fakten.
Tutorials
/docs/tutorial-01-erste-schritte.md- Schnellstart: Repo klonen, Container starten, erster Login.
/docs/tutorial-02-systemueberblick.md- Produktbild, Kernmodule und Lernziel in 10 Minuten.
/docs/tutorial-03-setup-und-erster-login.md- Lokales Setup, erster Login, erster Smoke-Test.
/docs/tutorial-04-architektur-request-flow.md- Request-Flow, Schichtmodell, Do/Don't.
/docs/tutorial-05-erste-aenderung-ui.md- Erste sichere UI-Aenderung im Admin-Bereich.
/docs/tutorial-06-erste-aenderung-backend.md- Erste Backend-/Service-/Repository-Aenderung.
/docs/tutorial-07-security-tenant-scope.md- Sicherheitsgrundlagen, Tenant-Scope, Pflichtchecks.
/docs/tutorial-08-api-erweitern.md- API-Aenderung sauber mit OpenAPI und Tests umsetzen.
/docs/tutorial-09-advanced-scheduler-sso.md- Fortgeschrittene Themen: Scheduler, Lifecycle, SSO.
How-to Guides
/docs/howto-erste-aenderung.md- Schritt-fuer-Schritt durch die erste Codeaenderung.
/docs/howto-globale-suche.md- Neue Resource in der globalen Suche integrieren.
/docs/howto-importe.md- Importfluss, Regeln und Fehlercodes.
/docs/howto-benutzerdefinierte-felder.md- Tenant/User-Zusatzfelder korrekt erweitern.
/docs/howto-geplante-aufgaben.md- Neue Scheduler-Jobs registrieren und betreiben.
/docs/howto-auth-sso-smoke-test.md- SSO-Funktionalitaet manuell verifizieren.
/docs/howto-anfragelimits.md- Rate-Limits verstehen und testen.
/docs/howto-rbac-permissions-playbook.md- RBAC-Rechte sauber erweitern (neue Permission, neue Ability, UI/API-Faelle).
/docs/howto-request-input-validation.md- Einheitliches Request/Input- und Validation-Muster fuer Web + API.
/docs/howto-docker-lokal.md- Lokaler Docker-Betrieb.
/docs/howto-docker-produktiv.md- Produktivbetrieb mit Docker.
/docs/howto-betriebscheck-doctor.md- Schneller Systemcheck mit
bin/doctor.php.
- Schneller Systemcheck mit
/docs/howto-fehlerbehebung.md- Haeufige Fehler und schnelle Loesungen.
/docs/howto-lokale-entwicklung.md- Tages-Workflow fuer Entwicklung und Checks.
/docs/howto-dokumentation-erweitern.md- Regeln fuer konsistente, wachsende Doku.
Explanation
/docs/explanation-architektur.md- Architektur-Kompass mit verbindlichen Leitplanken.
/docs/explanation-di-container.md- Wie der AppContainer funktioniert und neue Services registriert werden.
/docs/explanation-sicherheitsmodell.md- Vollstaendiges Sicherheitsmodell (Auth, Permission, Scope).
/docs/explanation-einstellungen-speicherung.md- Warum Settings in DB + Datei-Cache koexistieren.
/docs/explanation-docker-betrieb.md- Uebersicht und Entscheidungshilfe fuer Dev/Prod.
Reference
/docs/reference-domain-glossar.md- Zentrale Begriffe (Tenant, Role, Permission, Scope, Policy).
/docs/reference-api.md- API-Referenz-Einstieg.
/docs/reference-konfiguration.md- ENV-Variablen und Produktions-Defaults.
/docs/reference-konventionen.md- Projektweite Konventionen (kurz und verbindlich).
/docs/reference-lib-standards.md- Regeln speziell fuer
lib/**.
- Regeln speziell fuer
/docs/reference-benutzer-lifecycle-policy.md- Policy- und Laufzeitreferenz fuer User Lifecycle.
/docs/reference-frontend-css.md- CSS-Schichtsystem und Namenskonventionen.
/docs/reference-frontend-javascript.md- JS-Module, DOM-Utilities und Patterns.
/docs/reference-entwickler-checkliste.md- Definition of Done vor Merge.
/docs/reference-codex-prompts.md- Standard-Prompts fuer Skill-basierte Planung und Implementierung.
/docs/reference-agents-overview.md- Einstieg in das Rollenmodell und die Artefakte.
/docs/reference-agents-roles.md- Klare Verantwortung je Rolle (Planner, Executor, Reviewer, Finalizer).
/docs/reference-agents-flow.md- State-Flow mit Fail-Loop zur Executor-Iteration.