Michael Schiemer
77abc65cd7
Some checks failed
Deploy Application / deploy (push) Has been cancelled
176 lines
7.0 KiB
Markdown
176 lines
7.0 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)
|
|
- [Architektur-Verbesserungen](ARCHITECTURE_IMPROVEMENTS.md)
|
|
|
|
### Features
|
|
|
|
#### Database
|
|
- [Database Patterns](features/database/patterns.md)
|
|
- [Migrations](features/database/migrations.md)
|
|
- [Seeding](database/seeding.md) - Seed-System für Initial-Daten
|
|
- [Neue Features](database/new-features.md)
|
|
|
|
#### Queue System
|
|
- [Queue System](features/queue/system.md)
|
|
- [Scheduler & Pipeline](features/queue/scheduler.md)
|
|
- [Queue Deployment](queue-deployment.md)
|
|
|
|
#### Events
|
|
- [Event System](features/events/system.md)
|
|
|
|
#### Error Handling
|
|
- [Error Handling Guide](features/error-handling/guide.md)
|
|
- [Advanced Error Handling](features/error-handling/advanced.md)
|
|
- [Error Handling Audit](ERROR-HANDLING-AUDIT-REPORT.md)
|
|
- [Error Handling Migration](ERROR-HANDLING-MIGRATION-PLAN.md)
|
|
|
|
#### Security
|
|
- [Security Patterns](features/security/patterns.md)
|
|
- [Route Authorization](features/security/route-authorization.md)
|
|
- [Security Guide](guides/security.md)
|
|
|
|
#### Filesystem
|
|
- [Filesystem Patterns](features/filesystem/patterns.md)
|
|
|
|
#### View Transitions
|
|
- [View Transitions API](features/view-transitions.md)
|
|
|
|
#### Routing
|
|
- [Routing Value Objects](features/routing/value-objects.md)
|
|
- [Routing Guide](guides/routing.md)
|
|
|
|
### Komponenten
|
|
- **Analytics**
|
|
- [Übersicht](components/analytics/index.md)
|
|
- [Konfiguration](components/analytics/configuration.md)
|
|
- [Beispiele](components/analytics/examples.md)
|
|
- **Authentication**
|
|
- [Übersicht](components/auth/index.md)
|
|
- [Konfiguration](components/auth/configuration.md)
|
|
- [Beispiele](components/auth/examples.md)
|
|
- [Security](components/auth/security.md)
|
|
- **Cryptography**
|
|
- [Übersicht](components/cryptography/index.md)
|
|
- [Konfiguration](components/cryptography/configuration.md)
|
|
- [Beispiele](components/cryptography/examples.md)
|
|
- [Security](components/cryptography/security.md)
|
|
- **Security**
|
|
- [Übersicht](components/security/index.md)
|
|
- [CSRF Protection](components/security/csrf-protection.md)
|
|
- [Security Headers](components/security/security-headers.md)
|
|
- [Request Signing](components/security/request-signing.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)
|
|
- [Feedback](components/waf/feedback.md)
|
|
|
|
### LiveComponents
|
|
- [LiveComponents Übersicht](livecomponents/README.md)
|
|
- [Getting Started](livecomponents/01-getting-started.md)
|
|
- [API Reference](livecomponents/api-reference.md)
|
|
- [Attributes Reference](livecomponents/attributes-reference.md)
|
|
- [Events Reference](livecomponents/events-reference.md)
|
|
- [Best Practices](livecomponents/best-practices.md)
|
|
- [Advanced Features](livecomponents/advanced-features.md)
|
|
- [Performance Guide](livecomponents/performance-guide.md)
|
|
- [Security Guide](livecomponents/security-guide.md)
|
|
- [Troubleshooting](livecomponents/troubleshooting.md)
|
|
- [FAQ](livecomponents/faq.md)
|
|
|
|
### Entwickleranleitungen
|
|
- [Routing](guides/routing.md)
|
|
- [Controller](guides/controllers.md)
|
|
- [Validierung](guides/validation.md)
|
|
- [Security](guides/security.md)
|
|
- [Common Workflows](guides/common-workflows.md)
|
|
- [Troubleshooting](guides/troubleshooting.md)
|
|
- [Configuration Best Practices](guides/configuration.md)
|
|
- [Image Upload](guides/README-image-upload.md)
|
|
- [Static Site](guides/README-static-site.md)
|
|
- [WebSocket](guides/README-websocket.md)
|
|
- [Migrating to Modern Features](guides/migrating-to-modern-features.md)
|
|
|
|
### API-Dokumentation
|
|
- [API-Übersicht](api/index.md)
|
|
- [API Versioning Examples](api-versioning-examples.md)
|
|
- [Batch API Examples](batch-api-examples.md)
|
|
- [GraphQL Examples](graphql-examples.md)
|
|
- [Search API Examples](search-api-examples.md)
|
|
|
|
### Deployment
|
|
- [Deployment Übersicht](deployment/README.md)
|
|
- [Ansible Deployment](deployment/ANSIBLE_DEPLOYMENT.md)
|
|
- [SSL Setup](deployment/ssl-setup.md)
|
|
- [WireGuard Setup](deployment/WIREGUARD-SETUP.md)
|
|
- [Logging Configuration](deployment/logging-configuration.md)
|
|
- [Secrets Management](deployment/secrets-management.md)
|
|
- [Production Prerequisites](deployment/production-prerequisites.md)
|
|
|
|
### Weitere Themen
|
|
- [Console Best Practices](console-best-practices.md)
|
|
- [Console Dialog Mode](console-dialog-mode.md)
|
|
- [Console Optional Parameters](console-optional-parameters.md)
|
|
- [Logging](logging/best-practices.md)
|
|
- [Performance](performance/index-optimization.md)
|
|
- [ML Model Management](ml-model-management.md)
|
|
- [Vault System](vault-system.md)
|
|
- [Design Token System](design-token-system.md)
|
|
- [Template System Analysis](TEMPLATE-SYSTEM-ANALYSIS.md)
|
|
|
|
### AI-spezifische Dokumentation
|
|
- [Claude Documentation](claude/README.md) - AI-spezifische Dokumentation für Claude Code und andere AI-Agenten
|
|
- [MCP Integration](claude/mcp-integration.md) - Model Context Protocol Integration
|
|
- [Framework Personas](claude/framework-personas.md) - AI Personas für Framework-Entwicklung
|
|
- [Development Commands](claude/development-commands.md) - Claude Code Commands
|
|
- [Guidelines](claude/guidelines.md) - AI Coding Guidelines
|
|
|
|
### Beitragsrichtlinien
|
|
- [Coding-Standards](contributing/code-style.md)
|
|
- [Pull-Request-Prozess](contributing/pull-requests.md)
|
|
- [Dokumentationsrichtlinien](contributing/documentation.md)
|
|
- [Git Hooks](contributing/git-hooks.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.
|