Skip to content

Konvention für Projekt-Doku ​

Geänderte Dateien ​

  • AGENTS.md: Abschnitt 6 "Dokumentation aus anderen Projekten" ergänzt, Schreibrechte-Tabelle auf docs/generated/<projekt>/ angepasst. AGENTS.md ist keine Agentenfläche, die Änderung ist ein Vorschlag auf Anweisung des Repo-Inhabers und braucht Review.

Quellen ​

  • README.md, AGENTS.md, .github/CODEOWNERS, scripts/generate_sidebar.py, scripts/update.sh.
  • Entscheidung des Repo-Inhabers: Projekte reichen ihre Doku direkt per PR ein.

Offen ​

  • generate_sidebar.py bildet verschachtelte Ordner ab (Ordnername als Gruppe). Die index.md eines Projektordners erscheint dort nicht, weil index.md ausgenommen ist. TODO: im Vorschlag nicht gelöst, Projekt-Index von docs/generated/index.md aus verlinken oder das Skript anpassen.
  • Zugriff der Projekte (Bot-Account und Token oder Forks) ist nicht eingerichtet.
  • Branch-Schutz auf main nicht geprüft.
  • CODEOWNERS liegt unter .github/ und nennt @michaexel-copilot. TODO: prüfen, ob Gitea die Datei dort liest und ob der Owner stimmt.
  • Nach einem Merge wird die Seite erst durch scripts/update.sh auf dem Server aktualisiert.
  • npm run build nicht ausgeführt, Python ist auf diesem Rechner nicht verfügbar (Sidebar-Skript lief nicht).

Vorschläge für docs/guides/ ​

  • Kurze Anleitung "Doku aus einem Projekt einreichen" mit Beispiel-PR und Textbaustein für die AGENTS.md der Projekte.