Enable Discovery debug logging for production troubleshooting
- Add DISCOVERY_LOG_LEVEL=debug - Add DISCOVERY_SHOW_PROGRESS=true - Temporary changes for debugging InitializerProcessor fixes on production
This commit is contained in:
107
docs/README.md
107
docs/README.md
@@ -1,77 +1,68 @@
|
||||
# Projekt-Dokumentation
|
||||
# Framework Dokumentation
|
||||
|
||||
## Übersicht
|
||||
|
||||
Willkommen zur Dokumentation des Projekts. Diese Dokumentation dient als zentrale Informationsquelle für Entwickler, die am Projekt arbeiten.
|
||||
Willkommen zur Dokumentation des Frameworks. Diese Dokumentation bietet umfassende Informationen zur Installation, Konfiguration und Verwendung des Frameworks sowie detaillierte Beschreibungen aller Komponenten und Funktionen.
|
||||
|
||||
## Inhaltsverzeichnis
|
||||
## Dokumentationsstruktur
|
||||
|
||||
### Standards und Guidelines
|
||||
Die Dokumentation ist in folgende Hauptbereiche gegliedert:
|
||||
|
||||
- [Coding Guidelines](/docs/standards/CODING-GUIDELINES.md) - Allgemeine Coding-Standards für das Projekt
|
||||
- [Sicherheitsrichtlinien](/docs/standards/SICHERHEITS-GUIDELINES.md) - Standards für sichere Softwareentwicklung
|
||||
### Erste Schritte
|
||||
- [Installation](getting-started/installation.md)
|
||||
- [Konfiguration](getting-started/configuration.md)
|
||||
- [Erste Schritte](getting-started/first-steps.md)
|
||||
|
||||
### Entwicklungsrichtlinien
|
||||
### Architektur
|
||||
- [Architekturübersicht](architecture/overview.md)
|
||||
- [Hauptkomponenten](architecture/components.md)
|
||||
- [Entwurfsmuster](architecture/patterns.md)
|
||||
|
||||
- [Performance Guidelines](/docs/guidelines/PERFORMANCE-GUIDELINES.md) - Richtlinien zur Optimierung der Anwendungsleistung
|
||||
- [Testing Guidelines](/docs/guidelines/TESTING-GUIDELINES.md) - Standards und Best Practices für Tests
|
||||
### Komponenten
|
||||
- **Analytics**
|
||||
- [Übersicht](components/analytics/index.md)
|
||||
- [Konfiguration](components/analytics/configuration.md)
|
||||
- [Beispiele](components/analytics/examples.md)
|
||||
- **Validation**
|
||||
- [Übersicht](components/validation/index.md)
|
||||
- [Validierungsregeln](components/validation/rules.md)
|
||||
- [Beispiele](components/validation/examples.md)
|
||||
- **WAF (Web Application Firewall)**
|
||||
- [Übersicht](components/waf/index.md)
|
||||
- [Machine Learning](components/waf/machine-learning.md)
|
||||
- [Konfiguration](components/waf/configuration.md)
|
||||
|
||||
### KI-Assistent Konfiguration
|
||||
### Entwickleranleitungen
|
||||
- [Routing](guides/routing.md)
|
||||
- [Controller](guides/controllers.md)
|
||||
- [Validierung](guides/validation.md)
|
||||
|
||||
- [Guidelines für KI-Assistenten](/docs/ai/GUIDELINES-FÜR-AI-ASSISTANT.md) - Spezifische Richtlinien für den KI-Assistenten
|
||||
- [PhpStorm Einrichtung](/docs/ai/EINRICHTUNG-PHPSTORM.md) - Anleitung zur Einrichtung des KI-Assistenten in PhpStorm
|
||||
### API-Dokumentation
|
||||
- [API-Übersicht](api/index.md)
|
||||
|
||||
### Architektur und Struktur
|
||||
### Beitragsrichtlinien
|
||||
- [Coding-Standards](contributing/code-style.md)
|
||||
- [Pull-Request-Prozess](contributing/pull-requests.md)
|
||||
- [Dokumentationsrichtlinien](contributing/documentation.md)
|
||||
|
||||
- [Projektstruktur](/docs/architecture/STRUKTUR-DOKUMENTATION.md) - Überblick über die Struktur des Projekts
|
||||
### Projektplanung
|
||||
- [Features](roadmap/features.md)
|
||||
- [Tasks](roadmap/tasks.md)
|
||||
- [Meilensteine](roadmap/milestones.md)
|
||||
|
||||
### Framework-Entwicklung
|
||||
## Dokumentationsstandards
|
||||
|
||||
- [Modul-Checkliste](/docs/framework/MODUL-CHECKLISTE.md) - Leitfaden für die Erstellung neuer Module
|
||||
- [Erweiterungsmuster](/docs/framework/ERWEITERUNGSPATTERN.md) - Muster zur Erweiterung des Frameworks
|
||||
Diese Dokumentation folgt einheitlichen Standards, um Konsistenz und Benutzerfreundlichkeit zu gewährleisten:
|
||||
|
||||
### Framework-Module
|
||||
1. **Struktur**: Jedes Dokument beginnt mit einer Übersicht und gliedert sich dann in logische Abschnitte.
|
||||
2. **Codebeispiele**: Alle Codebeispiele sind vollständig und funktionsfähig.
|
||||
3. **Querverweise**: Verwandte Themen werden durch Links miteinander verbunden.
|
||||
4. **Aktualität**: Die Dokumentation wird regelmäßig aktualisiert, um den aktuellen Stand der Implementierung widerzuspiegeln.
|
||||
|
||||
- [Analytics-Modul](/docs/framework/analytics/README.md) - Tracking und Analyse von Anwendungsdaten
|
||||
- [Core-Modul](/docs/framework/core/README.md) - Kernkomponenten und Event-System
|
||||
- [DI-Modul](/docs/framework/di/README.md) - Dependency-Injection-Container
|
||||
- [HTTP-Modul](/docs/framework/http/README.md) - HTTP-Request und -Response-Handling
|
||||
## Mitwirkung an der Dokumentation
|
||||
|
||||
## Mitwirken
|
||||
Wir begrüßen Beiträge zur Verbesserung dieser Dokumentation. Bitte beachten Sie die [Dokumentationsrichtlinien](contributing/documentation.md) für Informationen zum Beitragsprozess.
|
||||
|
||||
### Neue Module entwickeln
|
||||
## Feedback
|
||||
|
||||
1. Folge der [Framework-Modul Checkliste](/docs/framework/MODUL-CHECKLISTE.md) für neue Module
|
||||
2. Stelle sicher, dass dein Code den [Coding Guidelines](/docs/standards/CODING-GUIDELINES.md) entspricht
|
||||
3. Schreibe Tests gemäß den [Testing Guidelines](/docs/guidelines/TESTING-GUIDELINES.md)
|
||||
4. Erstelle eine ausführliche Dokumentation für dein Modul
|
||||
|
||||
### Dokumentation verbessern
|
||||
|
||||
Wir begrüßen Beiträge zur Verbesserung der Dokumentation. Wenn du Fehler findest oder Vorschläge zur Verbesserung hast, erstelle bitte einen Pull Request mit deinen Änderungen.
|
||||
|
||||
## Erste Schritte
|
||||
|
||||
Neue Entwickler sollten mit folgenden Schritten beginnen:
|
||||
|
||||
1. Projekt lokal einrichten (siehe [Installation](#installation))
|
||||
2. Die [Projektstruktur](/docs/architecture/STRUKTUR-DOKUMENTATION.md) verstehen
|
||||
3. Die [Coding Guidelines](/docs/standards/CODING-GUIDELINES.md) lesen
|
||||
4. PhpStorm mit dem [KI-Assistenten einrichten](/docs/ai/EINRICHTUNG-PHPSTORM.md)
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
# Repository klonen
|
||||
git clone [repository-url]
|
||||
|
||||
# Abhängigkeiten installieren
|
||||
composer install
|
||||
|
||||
# Entwicklungsserver starten
|
||||
php -S localhost:8000 -t public/
|
||||
```
|
||||
|
||||
## Updates und Änderungen
|
||||
|
||||
Diese Dokumentation wird kontinuierlich aktualisiert. Prüfe regelmäßig auf Aktualisierungen, um über die neuesten Best Practices und Standards informiert zu bleiben.
|
||||
Wenn Sie Fragen, Anregungen oder Feedback zur Dokumentation haben, erstellen Sie bitte ein Issue im Repository oder kontaktieren Sie das Entwicklungsteam direkt.
|
||||
|
||||
Reference in New Issue
Block a user