WDDocumentationStatische HTML-Version
activeagentsauthoringcodex

Dokumentations-Wiki

Bearbeite ausschließlich das Forgejo-Repository documentation-content. Bearbeite niemals content/current, Releases oder Laufzeitverzeichnisse direkt.

Lies vor jeder Änderung diese AGENTS.md, _wiki/navigation.html, das Autorenhandbuch und den CommonMark-Klassenvertrag. Arbeite in einem frischen Branch oder Worktree auf Basis von aktuellem main.

Pflicht: System- und Wikiänderungen dokumentieren

Baue vor Infrastruktur-, MCP-, Codex- oder Supportarbeiten zuerst Wissen aus dem produktiven Wiki auf. Nutze dafür je nach verfügbarer Oberfläche documentation-wiki, die documentation__*-MCP-Tools oder die Wiki-API. Beginne mit Status, Themenbaum, Suche und den relevanten Originalquellen. Nutze eine LLM-Frage über den Wiki-Assistenten nur zur quellengebundenen Synthese; sie ersetzt nicht das Lesen der maßgeblichen Seiten.

Jede Änderung an einem dokumentierten System muss im selben Arbeitsauftrag im Repository documentation-content reflektiert werden. Dazu gehören insbesondere:

  • Serverpfade, Dienste, Supervisor-Prozesse und Laufzeitabhängigkeiten;
  • öffentliche oder interne URLs, APIs, MCPs und OAuth-Verträge;
  • Deployment, Rollback, Authentifizierung und Betriebsabläufe;
  • Codex-Adapter, Account-Auswahl, Modelle und Reasoning-Konfiguration;
  • Wiki-Funktionen, UI-Verhalten, Content-Schema, Navigation und Klassenvertrag.

Aktualisiere bevorzugt die bestehende kanonische Seite. Lege nur dann eine neue Seite an, wenn kein passender Eintrag existiert. Prüfe dabei Titel, Summary, Status, Tags, Related-Links, Owner und reviewed_at. Änderungen an Wiki-Features oder der Wiki-Struktur müssen zusätzlich im Autorenhandbuch, in der Wiki-Architektur und – falls betroffen – in _wiki/navigation.html, der LLM-Dokumentation oder dem CommonMark-Klassenvertrag nachvollziehbar sein.

Dokumentiere keine Secrets, Bearer, Zugangscodes, Cookies, privaten Prompts oder personenbezogenen Accountdaten. Veröffentliche erst, wenn Content-Build, Navigation, Links, HTML-Export und ZIP erfolgreich sind.

Jede Markdown-Seite benötigt gültiges wiki-page/v1-Frontmatter. Jede eigenständige HTML-Seite benötigt wiki-page-metadata.

Hauptnavigation

  • placement: main
  • gültiges Topic aus _wiki/navigation.html
  • eindeutige ID
  • gültiger Elternknoten oder kein parent-Feld
  • numerische Reihenfolge
  • optional erlaubte Appearance-ID

Wiki-interne Seiten

  • placement: footer
  • eindeutige ID
  • numerische Reihenfolge
  • kein Topic und kein Elternknoten

Eine Seite besitzt nur einen kanonischen Menüplatz. Nutze Tags, Aliase, Related-Links und Suche für Querschnittsthemen.

Markdown ist das Standardformat. Verwende die freigegebenen Klassen für Tabellen, Bilder, Karten, Schritte, Baumlisten, Status, Code, Buttons und aufklappbare Hinweise. Aktives HTML ist nur bei echter Interaktion oder einer komplexen Visualisierung vorgesehen.

Änderungen an _wiki/navigation.html gelten als Änderungen an vertrauenswürdigem Anwendungscode. Prüfe HTML, CSS und JavaScript gesondert und dokumentiere den freizugebenden SHA-256.

Vor dem Commit müssen produktiver Content-Build, Navigation, Links, statische HTML-Version, ZIP, Desktop- und Mobilansicht sowie Secret- und PII-Prüfung erfolgreich sein.

Suchergebnisse