Generiert Projektdokumentation aus Laravel-Codebases mit MkDocs Material. Nutze bei: "Dokumentation erstellen", "Doku generieren", "Server-Doku", "Installationsanleitung", "Projekt dokumentieren", "Übergabe-Doku", "MkDocs aufsetzen", "welche Cronjobs/Commands gibt es".
docs/
├── technik/ (Architektur, Models, Routes, Services, Commands, API)
├── server/ (Anforderungen, Installation, Deployment, Cronjobs, Environment)
└── kunde/ (Übersicht, Admin-Bereich, FAQ)
mkdocs build → site/ Ordner (in .gitignore!)Im Code platzieren – wird beim Scan automatisch erfasst:
/** @doc:cron Täglich 3:00 Uhr: Sitemap generieren */
/**
* @doc:setup
* composer install && php artisan migrate
* npm run build
*/
/** @doc:env MAIL_MAILER – smtp für Produktion, log für Entwicklung */
/** @doc:api POST /api/webhook – Mollie Payment Webhook */
/** @doc:admin Unter "Einstellungen" können Firmendaten geändert werden */
Tags: @doc:setup, @doc:cron, @doc:env, @doc:api, @doc:admin, @doc:queue, @doc:config, @doc:migration, @doc:security, @doc:performance, @doc:troubleshoot
php artisan route:list --json
ls app/Models/
ls app/Console/Commands/
grep -r "@doc:" app/ config/ routes/ --include="*.php"
php artisan schedule:list
cat .env.example
| Seite | Quelle | Inhalt |
|---|---|---|
| architektur.md | Code-Analyse | Ordnerstruktur, Patterns, Tech-Stack |
| models.md | app/Models/ | Relationen, Scopes, Casts, Factories |
| routes.md | route:list | Gruppiert nach Prefix, Middleware |
| services.md | app/Services/ | Public Methods, Abhängigkeiten |
| commands.md | Commands/ + schedule:list | Signatur, Beschreibung, Schedule |
| installation.md | @doc:setup + .env.example | Schritt-für-Schritt |
| environment.md | .env.example + @doc:env | Alle Variablen mit Erklärung |
| cronjobs.md | schedule:list + @doc:cron | Frequenz, Zweck |
# mkdocs.yml (Minimal)
site_name: "{Projekt} Dokumentation"