From: Kai Moritz Date: Wed, 17 Jun 2026 19:33:31 +0000 (+0000) Subject: Add CLAUDE.md and AGENTS.md; project docs now live in README.md X-Git-Url: http://juplo.de/gitweb/?a=commitdiff_plain;h=e5b3083be967143f4f9a3c68ec54183a336e8061;p=maven-thymeleaf-skin Add CLAUDE.md and AGENTS.md; project docs now live in README.md New CLAUDE.md contains only AI working rules and regeneration instructions, and references README.md for project documentation. AGENTS.md is a short pointer for other AI coding assistants. --- diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000..be4db7d --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,5 @@ +# AGENTS.md + +For project documentation, architecture, and import script reference, see [README.md](README.md). + +For working rules and commit conventions when using an AI coding assistant, see [CLAUDE.md](CLAUDE.md). diff --git a/CLAUDE.md b/CLAUDE.md new file mode 100644 index 0000000..94a2d4a --- /dev/null +++ b/CLAUDE.md @@ -0,0 +1,63 @@ +# CLAUDE.md + +Diese Datei enthält Anweisungen für Claude Code (claude.ai/code) beim Arbeiten mit diesem Repository. + +Für die Projektdokumentation (Was ist StILi, Funktionsweise, Import-Skripte) siehe [README.md](README.md). + +## Arbeitsregeln + +- Ab und zu bin ich ungenau oder bringe Details durcheinander. Wenn du den Eindruck hast, dass etwas nicht passt oder Details fehlen, frage immer direkt nach. +- Für alle Aufgaben gilt: du kannst und sollst Nachfragen stellen, bevor du mit der Umsetzung beginnst, wenn das sinnvoll ist. +- Änderungen immer so vornehmen, dass die Diffs minimal sind und sich gut per Review kontrollieren lassen: nur ändern, was tatsächlich geändert werden muss — keine Umformatierungen, Umstrukturierungen oder Neusortierungen, die nichts zur eigentlichen Änderung beitragen. + +## Commits + +- Erstelle nach dem Abschluss einer Aufgabe jeweils einen Commit — direkt, ohne vorher nachzufragen. +- Fasse in der Commit-Nachricht zusammen, was und warum geändert wurde. +- Nach jedem Commit wird gemeinsam geprüft, ob der Build noch zufriedenstellend funktioniert, bevor der nächste Schritt angegangen wird. + +## Maven Wrapper + +Das Projekt verwendet den **Maven Wrapper** (`mvnw` / `mvnw.cmd`), der Maven automatisch herunterlädt falls es nicht lokal vorhanden ist. + +```bash +./mvnw clean site # statt: mvn clean site +./mvnw wrapper:wrapper # Wrapper-Dateien neu generieren (erfordert Maven) +``` + +**Dateien:** +- `.mvn/wrapper/maven-wrapper.properties` — Maven-Version und Download-URL (Single Source of Truth für die Maven-Version des Wrappers) +- `mvnw` — Unix-Startskript (Apache Maven Wrapper 3.3.2) +- `mvnw.cmd` — Windows-Startskript (Apache Maven Wrapper 3.3.2) + +## Maven-Site-Dokumentation neu generieren + +Die Markdown-Dateien unter `src/site/markdown/` sind aus README.md abgeleitet und werden **manuell auf Anforderung** neu generiert. + +**Trigger:** `"Bitte generiere die Maven-Site-Dokumentation neu"` oder sinngemäß. + +### Mapping README.md → Dokumentation + +| README.md-Abschnitt | Datei | +|---|---| +| What is StILi? + Design Principle | `src/site/markdown/index.md` | +| How It Works (site.vm, JSON, page types, extraction) | `src/site/markdown/architecture.md` | +| Import Scripts → import-in-hugo.sh | `src/site/markdown/import-in-hugo.md` | +| Import Scripts → import-in-astro.sh | `src/site/markdown/import-in-astro.md` | + +### Wann neu generieren? + +Nur bei inhaltlichen Änderungen an diesen README.md-Abschnitten: + +- „What is StILi?" oder „Design Principle" +- „How It Works" (site.vm, JSON, Seitentypen, Extraktion) +- „Import Scripts" (Parameter, Ausgaben, Beispiele) + +Nicht neu generieren für: Arbeitsregeln, Commit-Anweisungen, reine Formulierungsänderungen ohne Informationsgewinn. + +### Vorgehen + +1. Lies die inhaltlich relevanten Abschnitte der README.md +2. Überarbeite **nur** die betroffenen Stellen in den entsprechenden Markdown-Dateien (Mapping siehe oben) +3. Halte Formatierung, Überschriften-Hierarchie und Tabellenstruktur stabil — ändere nur was sich inhaltlich geändert hat +4. Committe die aktualisierten Dateien