Michael Schiemer
55a330b223
- Add DISCOVERY_LOG_LEVEL=debug - Add DISCOVERY_SHOW_PROGRESS=true - Temporary changes for debugging InitializerProcessor fixes on production
69 lines
2.6 KiB
Markdown
69 lines
2.6 KiB
Markdown
# 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
|
|
- [Installation](getting-started/installation.md)
|
|
- [Konfiguration](getting-started/configuration.md)
|
|
- [Erste Schritte](getting-started/first-steps.md)
|
|
|
|
### Architektur
|
|
- [Architekturübersicht](architecture/overview.md)
|
|
- [Hauptkomponenten](architecture/components.md)
|
|
- [Entwurfsmuster](architecture/patterns.md)
|
|
|
|
### 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)
|
|
|
|
### Entwickleranleitungen
|
|
- [Routing](guides/routing.md)
|
|
- [Controller](guides/controllers.md)
|
|
- [Validierung](guides/validation.md)
|
|
|
|
### API-Dokumentation
|
|
- [API-Übersicht](api/index.md)
|
|
|
|
### Beitragsrichtlinien
|
|
- [Coding-Standards](contributing/code-style.md)
|
|
- [Pull-Request-Prozess](contributing/pull-requests.md)
|
|
- [Dokumentationsrichtlinien](contributing/documentation.md)
|
|
|
|
### Projektplanung
|
|
- [Features](roadmap/features.md)
|
|
- [Tasks](roadmap/tasks.md)
|
|
- [Meilensteine](roadmap/milestones.md)
|
|
|
|
## Dokumentationsstandards
|
|
|
|
Diese Dokumentation folgt einheitlichen Standards, um Konsistenz und Benutzerfreundlichkeit zu gewährleisten:
|
|
|
|
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.
|
|
|
|
## Mitwirkung an der Dokumentation
|
|
|
|
Wir begrüßen Beiträge zur Verbesserung dieser Dokumentation. Bitte beachten Sie die [Dokumentationsrichtlinien](contributing/documentation.md) 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.
|