Appearance
Textbaustein für Projekt-Repos
Geänderte Dateien
- Neu: diese Datei. Sie enthält den Entwurf und ändert sonst nichts.
Quellen
AGENTS.md, Abschnitt 6, aus Pull Request #2 (Stand: noch nicht gemergt, TODO: nach dem Merge abgleichen).- Entscheidung des Repo-Inhabers: Projekte reichen ihre Doku direkt per PR ein.
Entwurf
Gehört in die AGENTS.md oder CLAUDE.md des jeweiligen Projekts. Platzhalter in <…> pro Projekt ersetzen.
markdown
## Dokumentation im zentralen Doku-Repo
Die Doku dieses Projekts liegt in `https://gitea.michaexel.de/me/docs` (Seite: docs.michaexel.de). Verbindlich sind dort die Regeln in `AGENTS.md`, besonders Abschnitt 6. Lies sie vor dem ersten Run.
- **Projektname:** `<projekt>` (Repo-Name, Kleinbuchstaben, Bindestriche)
- **Ziel:** `docs/generated/<projekt>/` für Referenzen, `docs/journal/` für das Run-Protokoll. In keinem anderen Pfad schreiben, auch nicht in Ordnern anderer Projekte.
- **Ablauf:**
1. Doku-Repo klonen und Branch `agent/<projekt>-<thema>` anlegen. Nie direkt auf `main`.
2. Seiten schreiben: Markdown, Deutsch, Frontmatter mit `title`, `generated_by`, `last_updated`, `managed: auto`, genau eine `#`-Überschrift.
3. Neues Projekt: zuerst `docs/generated/<projekt>/index.md` anlegen (Zweck in einem Satz, Link zu diesem Repo).
4. Journal-Eintrag `docs/journal/JJJJ-MM-TT_agent-<projekt>-<thema>.md` anlegen (geänderte Dateien, Quellen, offene Punkte).
5. Pull Request mit Titel `[<projekt>] <Thema>` einreichen. Nicht selbst mergen, kein Force-Push.
- **Inhalt:** Nur Nachprüfbares aus Code, Konfiguration oder Befehlsausgaben dieses Projekts. Jede Seite nennt ihre Quelle (Commit oder Befehl). Unsicheres als `TODO:` kennzeichnen.
- **Keine Secrets:** Keine Tokens, Passwörter, Schlüssel, internen IPs oder personenbezogenen Daten. Platzhalter wie `<TOKEN>` nutzen.
- **Zugang:** Token des Bot-Accounts `<bot-account>` aus `<Ablageort, z. B. Umgebungsvariable DOCS_REPO_TOKEN>`. Nie in Dateien oder Commits schreiben.
- **Prüfen vor dem PR:** Nur erlaubte Pfade geändert (`git diff --stat`), Frontmatter vollständig, Journal-Eintrag vorhanden.Offen
- Der Bot-Account für den Zugang ist nicht eingerichtet. Bis dahin die Zeile "Zugang" anpassen oder streichen.
- Der Build ist bewusst nicht in der Prüfliste: Projekte haben das VitePress-Setup nicht lokal.
npm run buildnicht ausgeführt (Python fehlt auf diesem Rechner).
Vorschläge für docs/guides/
- Den Baustein als Seite "Doku aus einem Projekt einreichen" unter
docs/guides/übernehmen, mit einem Beispiel-PR.