laravel-docs
Skill1 starsChanged 7 months agoMITView on GitHub
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".
- Reads credentials
In this repository18 other files it gives its agents.
- architectureSkill
- audit-projectSkill
- backendSkill
- deploySkill
- docs-structureSkill
- frontendSkill
- geoSkill
- git-commitSkill
- helpSkill
- init-projectSkill
- laravel-a11ySkill
- laravel-performanceSkill
- laravel-security-auditSkill
- laravel-testsSkill
- portfolio-texteSkill
- qaSkill
- requirementsSkill
- seoSkill
The file
Files
Laravel Docs Generator (MkDocs Material)
Struktur
docs/
├── technik/ (Architektur, Models, Routes, Services, Commands, API)
├── server/ (Anforderungen, Installation, Deployment, Cronjobs, Environment)
└── kunde/ (Übersicht, Admin-Bereich, FAQ)Workflow
- Scan: Routes, Models, Migrations, Commands, Jobs, Config, .env scannen
- Validieren: Alle Migrations gelistet? Commands vollständig? @doc-Tags erfasst?
- Generieren: MkDocs-Seiten pro Bereich schreiben
- Build:
mkdocs build→site/Ordner (in .gitignore!)
@doc Annotations
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
Scan-Befehle
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.exampleContent pro Seite
| 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 Setup
# mkdocs.yml (Minimal)
site_name: "{Projekt} Dokumentation"
theme:
name: material
language: de
features: [navigation.sections, navigation.expand, search.highlight]
nav:
- Start: index.md
- Technik: [technik/architektur.md, technik/models.md, technik/routes.md]
- Server: [server/installation.md, server/environment.md, server/cronjobs.md]
- Kunde: [kunde/uebersicht.md, kunde/admin-bereich.md]Deployment
mkdocs build # Generiert site/
mkdocs gh-deploy # GitHub Pages
# oder: scp -r site/* user@server:/var/www/docs/Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.