Michael Schiemer
5050c7d73a
- Move 12 markdown files from root to docs/ subdirectories - Organize documentation by category: • docs/troubleshooting/ (1 file) - Technical troubleshooting guides • docs/deployment/ (4 files) - Deployment and security documentation • docs/guides/ (3 files) - Feature-specific guides • docs/planning/ (4 files) - Planning and improvement proposals Root directory cleanup: - Reduced from 16 to 4 markdown files in root - Only essential project files remain: • CLAUDE.md (AI instructions) • README.md (Main project readme) • CLEANUP_PLAN.md (Current cleanup plan) • SRC_STRUCTURE_IMPROVEMENTS.md (Structure improvements) This improves: ✅ Documentation discoverability ✅ Logical organization by purpose ✅ Clean root directory ✅ Better maintainability
Framework Dokumentation
Übersicht
Willkommen zur Dokumentation des Frameworks. Diese Dokumentation bietet umfassende Informationen zur Installation, Konfiguration und Verwendung des Frameworks sowie detaillierte Beschreibungen aller Komponenten und Funktionen.
Dokumentationsstruktur
Die Dokumentation ist in folgende Hauptbereiche gegliedert:
Erste Schritte
Architektur
Komponenten
- Analytics
- Validation
- WAF (Web Application Firewall)
Entwickleranleitungen
API-Dokumentation
Beitragsrichtlinien
Projektplanung
Dokumentationsstandards
Diese Dokumentation folgt einheitlichen Standards, um Konsistenz und Benutzerfreundlichkeit zu gewährleisten:
- Struktur: Jedes Dokument beginnt mit einer Übersicht und gliedert sich dann in logische Abschnitte.
- Codebeispiele: Alle Codebeispiele sind vollständig und funktionsfähig.
- Querverweise: Verwandte Themen werden durch Links miteinander verbunden.
- Aktualität: Die Dokumentation wird regelmäßig aktualisiert, um den aktuellen Stand der Implementierung widerzuspiegeln.
Mitwirkung an der Dokumentation
Wir begrüßen Beiträge zur Verbesserung dieser Dokumentation. Bitte beachten Sie die Dokumentationsrichtlinien für Informationen zum Beitragsprozess.
Feedback
Wenn Sie Fragen, Anregungen oder Feedback zur Dokumentation haben, erstellen Sie bitte ein Issue im Repository oder kontaktieren Sie das Entwicklungsteam direkt.