Files
breadcrumb-the-shire/docs/index.md
2026-03-06 00:44:52 +01:00

3.5 KiB

Dokumentation

Letzte Aktualisierung: 2026-03-04

Diese Dokumentation folgt einem klaren Lernpfad (einfach -> fortgeschritten) und trennt Lernen von Nachschlagen.

Lernpfad (chronologisch)

  1. /docs/00-systemueberblick.md
    • Produktbild, Kernmodule und Lernziel in 10 Minuten.
  2. /docs/01-setup-und-erster-login.md
    • Lokales Setup, erster Login, erster Smoke-Test.
  3. /docs/02-domain-glossar.md
    • Zentrale Begriffe (Tenant, Role, Permission, Scope, Policy).
  4. /docs/03-architektur-request-flow.md
    • Request-Flow, Schichtmodell, Do/Don't.
  5. /docs/04-erste-aenderung-ui.md
    • Erste sichere UI-Änderung im Admin-Bereich.
  6. /docs/05-erste-aenderung-backend.md
    • Erste Backend-/Service-/Repository-Änderung.
  7. /docs/06-security-tenant-scope.md
    • Sicherheitsgrundlagen, Tenant-Scope, Pflichtchecks.
  8. /docs/07-api-erweitern.md
    • API-Änderung sauber mit OpenAPI und Tests umsetzen.
  9. /docs/08-advanced-scheduler-sso.md
    • Fortgeschrittene Themen: Scheduler, Lifecycle, SSO.

Konzepte (Explanation)

  • /docs/architektur.md
    • Architektur-Kompass mit verbindlichen Leitplanken.
  • /docs/di-container.md
    • Wie der AppContainer funktioniert und neue Services registriert werden.
  • /docs/sicherheitsmodell.md
    • Vollständiges Sicherheitsmodell (Auth, Permission, Scope).
  • /docs/einstellungen-speicherung.md
    • Warum Settings in DB + Datei-Cache koexistieren.

Aufgabenanleitungen (How-to)

  • /docs/globale-suche.md
    • Neue Resource in der globalen Suche integrieren.
  • /docs/importe.md
    • Importfluss, Regeln und Fehlercodes.
  • /docs/benutzerdefinierte-felder.md
    • Tenant/User-Zusatzfelder korrekt erweitern.
  • /docs/geplante-aufgaben.md
    • Neue Scheduler-Jobs registrieren und betreiben.
  • /docs/auth-sso-smoke-test.md
    • SSO-Funktionalität manuell verifizieren.
  • /docs/anfragelimits.md
    • Rate-Limits verstehen und testen.
  • /docs/rbac-permissions-playbook.md
    • RBAC-Rechte sauber erweitern (neue Permission, neue Ability, UI/API-Fälle).
  • /docs/request-input-validation.md
    • Einheitliches Request/Input- und Validation-Muster für Web + API.

Referenz (Reference)

  • /docs/api.md
    • API-Referenz-Einstieg.
  • /docs/konfiguration.md
    • ENV-Variablen und Produktions-Defaults.
  • /docs/konventionen.md
    • Projektweite Konventionen (kurz und verbindlich).
  • /docs/lib-standards.md
    • Regeln speziell für lib/**.
  • /docs/benutzer-lifecycle-policy.md
    • Policy- und Laufzeitreferenz für User Lifecycle.

Betrieb (Operations)

  • /docs/docker-lokal.md
    • Lokaler Docker-Betrieb.
  • /docs/docker-produktiv.md
    • Produktivbetrieb mit Docker.
  • /docs/docker-betrieb.md
    • Übersicht und Entscheidungshilfe für Dev/Prod.
  • /docs/betriebscheck-doctor.md
    • Schneller Systemcheck mit bin/doctor.php.
  • /docs/fehlerbehebung.md
    • Häufige Fehler und schnelle Lösungen.

Mitwirken (Contributor Guide)

  • /docs/lokale-entwicklung.md
    • Tages-Workflow für Entwicklung und Checks.
  • /docs/entwickler-checkliste.md
    • Definition of Done vor Merge.
  • /docs/codex-prompts.md
    • Standard-Prompts für Skill-basierte Planung und Implementierung.
  • /docs/dokumentation-erweitern.md
    • Regeln für konsistente, wachsende Doku.

Agent Workflow

  • /docs/agents/overview.md
    • Einstieg in das Rollenmodell und die Artefakte.
  • /docs/agents/roles.md
    • Klare Verantwortung je Rolle (Planner, Executor, Reviewer, Finalizer).
  • /docs/agents/flow.md
    • State-Flow mit Fail-Loop zur Executor-Iteration.
  • /agent-system/README.md
    • Technische Basis mit Contracts, Templates, Prompts und Checks.