Rename the top-level lib/ directory to core/ so the project root immediately communicates which code is core platform and which lives in modules/. PHP namespaces (MintyPHP\*) are unchanged — only the Composer PSR-4 path mapping moves from lib/ to core/. Module-internal lib/ directories (modules/*/lib/) are untouched. Updated across the full stack: - composer.json PSR-4 mapping - bootstrap entry points (web/index.php, bin/*, tests/bootstrap.php) - tooling configs (phpstan.neon, phpunit.xml, php-cs-fixer) - 26 architecture contract tests - enforcement-policy, guard-catalog, quality-gates - all documentation (CLAUDE.md, README, 25 docs/, .agents/skills/) - bin/qa-extended.sh search paths - .claude/settings.local.json permission paths Workflow: .agents/runs/CORE-LIB-RENAME-001/ (Analyst → Planner → Executor → Code Review (4 findings fixed) → Security Review → Acceptance Test → Finalizer) Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2.1 KiB
2.1 KiB
Dokumentation erweitern
Letzte Aktualisierung: 2026-03-06
Ziel
Neue Seiten schnell, konsistent und langfristig wartbar ergänzen.
Informationsarchitektur (verbindlich)
/docs/index.md ist die einzige Navigationsquelle für:
- Admin-Doku (
/admin/docs/...) - Docs-Suche
- Vollsuche (
/search)
Die Dokumentation folgt dem Diataxis-Modell mit genau vier Quadranten in dieser Reihenfolge:
- Tutorials — Lernorientierte Schritt-fuer-Schritt-Anleitungen
- How-to Guides — Aufgabenorientierte Anleitungen fuer konkrete Ziele
- Explanation — Verstaendnisorientierte Hintergrunderklaerungen
- Reference — Informationsorientierte Fakten und Nachschlagewerke
Dateinamenformat: <quadrant-prefix>-<slug>.md, wobei Prefix nur tutorial-, howto-, explanation-, reference- ist.
Format pro Seite (kurz und klar)
Jede neue Seite soll kompakt bleiben:
- genau ein H1
Letzte Aktualisierung: YYYY-MM-DD## Ziel(1-2 Sätze)- maximal 3-6 H2-Abschnitte
- kurze Listen statt Fließtextblöcke
- konkrete Befehle oder Pfade
Richtwert: zuerst kurz, Details als Verweis auf Referenzseiten.
Standardablauf
- Datei in
docs/<prefix>-<slug>.mdanlegen (Prefix:tutorial-,howto-,explanation-,reference-). - Seite im passenden Diataxis-Quadranten in
docs/index.mdeintragen. - Aussagekräftige H2/H3-Überschriften setzen (für Suche).
- Relevante Querverweise ergänzen.
- Datum aktualisieren.
Qualitätscheck vor Merge
- Seite ist in
docs/index.mdeingetragen. - Struktur ist kurz, klar, ohne Redundanz.
- Pfade, Routen, Permissions stimmen mit dem Code.
- Instanziierungsregeln sind konsistent mit
/docs/explanation-architektur.mdund/docs/reference-core-standards.md. - Mindestens ein konkretes Beispiel ist enthalten.
- Begriffe sind konsistent mit
/docs/reference-domain-glossar.md.
Häufige Fehler
- Seite existiert, ist aber nicht im Index registriert.
- Lernpfad wird mit Referenztext überladen.
- Lange Detailtexte ohne klare Handlungsschritte.
- API-/Permission-Änderung im Code ohne Doku-Update.