michaelschiemer/docs

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
• Konfiguration
• Erste Schritte

Architektur

• Architekturübersicht
• Hauptkomponenten
• Entwurfsmuster
• Architektur-Verbesserungen

Features

Database

• Database Patterns
• Migrations
• Seeding - Seed-System für Initial-Daten
• Neue Features

Queue System

• Queue System
• Scheduler & Pipeline
• Queue Deployment

Events

• Event System

Error Handling

• Error Handling Guide
• Advanced Error Handling
• Error Handling Audit
• Error Handling Migration

Security

• Security Patterns
• Route Authorization
• Security Guide

Filesystem

• Filesystem Patterns

View Transitions

• View Transitions API

Routing

• Routing Value Objects
• Routing Guide

Komponenten

• Analytics
  • Übersicht
  • Konfiguration
  • Beispiele
• Authentication
  • Übersicht
  • Konfiguration
  • Beispiele
  • Security
• Cryptography
  • Übersicht
  • Konfiguration
  • Beispiele
  • Security
• Security
  • Übersicht
  • CSRF Protection
  • Security Headers
  • Request Signing
• Validation
  • Übersicht
  • Validierungsregeln
  • Beispiele
• WAF (Web Application Firewall)
  • Übersicht
  • Machine Learning
  • Konfiguration
  • Feedback

LiveComponents

• LiveComponents Übersicht
• Getting Started
• API Reference
• Attributes Reference
• Events Reference
• Best Practices
• Advanced Features
• Performance Guide
• Security Guide
• Troubleshooting
• FAQ

Entwickleranleitungen

• Routing
• Controller
• Validierung
• Security
• Common Workflows
• Troubleshooting
• Configuration Best Practices
• Image Upload
• Static Site
• WebSocket
• Migrating to Modern Features

API-Dokumentation

• API-Übersicht
• API Versioning Examples
• Batch API Examples
• GraphQL Examples
• Search API Examples

Deployment

• Deployment Übersicht
• Ansible Deployment
• SSL Setup
• WireGuard Setup
• Logging Configuration
• Secrets Management
• Production Prerequisites

Weitere Themen

• Console Best Practices
• Console Dialog Mode
• Console Optional Parameters
• Logging
• Performance
• ML Model Management
• Vault System
• Design Token System
• Template System Analysis

AI-spezifische Dokumentation

• Claude Documentation - AI-spezifische Dokumentation für Claude Code und andere AI-Agenten
• MCP Integration - Model Context Protocol Integration
• Framework Personas - AI Personas für Framework-Entwicklung
• Development Commands - Claude Code Commands
• Guidelines - AI Coding Guidelines

Beitragsrichtlinien

• Coding-Standards
• Pull-Request-Prozess
• Dokumentationsrichtlinien
• Git Hooks

Projektplanung

• Features
• Tasks
• Meilensteine

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 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.