Files
breadcrumb-the-shire/docs/index.md
2026-02-23 12:58:19 +01:00

2.7 KiB

Dokumentation

Letzte Aktualisierung: 2026-02-22

Diese Dokumente sind für Entwickler gedacht, die die Anwendung warten oder erweitern.

Start hier (neue Entwickler)

  1. /docs/erste-schritte.md
    • Setup in 30-45 Minuten, erster Login, erster Smoke-Test.
  2. /docs/lokale-entwicklung.md
    • Täglicher Workflow, Schema-Updates und Qualitätschecks.
  3. /docs/erste-aenderung.md
    • Schritt-für-Schritt für den ersten kleinen Code-Change.
  4. /docs/dokumentation-erweitern.md
    • Wie neue Doku-Dateien sauber erstellt, einsortiert und suchbar gemacht werden.
  5. /docs/entwickler-checkliste.md
    • Finale Checkliste vor Merge/Review.

Architektur und Regeln

  • /docs/architektur.md
    • Request-Lebenszyklus, Schichtentrennung, Frontend-Aufbau.
  • /docs/sicherheitsmodell.md
    • Auth, Permissions, Tenant-Scope, Public/API-Zugriffe.
  • /docs/konventionen.md
    • Coding- und Strukturkonventionen für PHP, Templates, CSS, JS.

Frontend

  • /docs/frontend-javascript.md
    • Frontend-JS-Aufbau, Init-Flow, Grid-Integration und URL-State-Sync.
  • /docs/frontend-css.md
    • CSS-Struktur, Layering, Vendor-Overrides und Asset-Einbindung.

Fach- und Feature-Dokumentation

  • /docs/benutzerdefinierte-felder.md
    • Tenant/User-Zusatzfelder (Typen, Pflege, Filterbarkeit).
  • /docs/importe.md
    • CSV-Import (V1), Mapping, Fehlercodes, Permission-Modell und Import-Audit.
  • /docs/einstellungen-speicherung.md
    • Source of truth für Settings (DB) und Datei-Cache-Verhalten.
  • /docs/anfragelimits.md
    • Login/API-Limits, Scopes, Block-Verhalten.
  • /docs/benutzer-lifecycle-policy.md
    • Automatische Benutzer-Deaktivierung/Löschung (Policy, Cron, manueller Run).
  • /docs/geplante-aufgaben.md
    • Zentrale geplante Aufgaben (Scheduler), Job-Konfiguration und Runner-Betrieb.
  • /docs/globale-suche.md
    • Globale Suche erweitern (Resource, Permission, Mapping, Aside-Integration).

API Referenz

  • /docs/api.md
    • API Quick Reference, Auth, Flows, Beispielaufrufe.
  • /docs/openapi.yaml
    • API Source of truth für Swagger UI.

Betriebswissen

  • /docs/konfiguration.md
    • Alle ENV-Variablen mit Beschreibung, Standardwerten und Produktions-Checkliste.
  • /docs/fehlerbehebung.md
    • Häufige Fehlerbilder und schnelle Lösungen.
  • /docs/auth-sso-smoke-test.md
    • Manueller Smoke-Runbook für Login, Microsoft-Start/Callback, Tenant-SSO-Save und Logout.
  • /docs/docker-lokal.md
    • Schneller lokaler Docker-Start inkl. typischer Befehle und Troubleshooting.
  • /docs/docker-produktiv.md
    • Produktionsbetrieb mit Domain, TLS und docker-compose.prod.yml.
  • /docs/docker-betrieb.md
    • Einstieg und Navigation zwischen lokaler und produktiver Docker-Doku.