diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 00000000..2e32fb19 --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,72 @@ +# Richtlinien für Codex Agents + +Diese Datei erläutert, wie Änderungen in diesem Repository vorgenommen werden sollen. Das Repository verwendet [Writerside](https://www.jetbrains.com/help/writerside/) von JetBrains für die Dokumentation. Writerside basiert auf Markdown, bietet jedoch zusätzliche Funktionen wie Snippets, Variablen und spezielle Tags. + +## Allgemeine Regeln +- Schreibe alle neuen Inhalte auf Deutsch. +- Achte auf eine freundliche, leicht verständliche Ausdrucksweise. +- Bestehende Dateien dürfen nicht ohne Grund gelöscht werden. +- Nutze Pull Requests mit aussagekräftigen Beschreibungen. + +## Writerside-spezifische Hinweise + - Writerside unterstützt Standard-Markdown sowie erweiterte Tags und eine XML-basierte Semantik. + - Wiederverwendbare Inhalte definierst du mit `...`. + - Über `` bindest du Snippets in andere Seiten ein. + - Variablen aus `Writerside/v.list` kannst du über `%varname%` nutzen. + - Hinweise und Warnungen werden mit `{style="note"}` bzw. `{style="warning"}` erzeugt. + - Registerkarten lassen sich mit `` und `` aufbauen. + - Definitionen verwendest du mit `` und ``. + - Neue Dokumentationsdateien legst du unter `Writerside/topics/` an. Die Struktur sollte zu den vorhandenen Unterordnern passen. + - Bilder kommen in `Writerside/images/`, Videos in `Writerside/videos/`. + - Achte darauf, IDs für Überschriften zu vergeben (`## Titel {id="..."}`), damit Links stabil bleiben. + - Bevor du Inhalte veröffentlichst, führe das Writerside-Build-Skript aus (falls vorhanden), um sicherzustellen, dass die Dokumentation fehlerfrei gerendert wird. + +### Kurzübersicht zum Writerside-Markup +Writerside kombiniert CommonMark mit zahlreichen XML‑Tags. Ein paar der wichtigsten Funktionen aus der Dokumentation sind: + +- **Absätze und Text**: Einfache Absätze brauchen keine besonderen Tags. Für Textblöcke kannst du `

` verwenden und über `{id="..."}` eigene IDs setzen. +- **Strukturelle Blöcke**: Verwende `` für längere Themenblöcke oder `` mit `` für Schritt‑an‑Schritt-Anleitungen. Inhaltslisten baust du mit `` oder ``, Tabellen mit ``, ``, `
`. +- **Ein- und ausklappbare Abschnitte**: `` bzw. `` ermöglichen Akkordeon-ähnliche Inhalte. +- **Links und Querverweise**: `[Linktext](url)` funktioniert wie gewohnt. Für interne Verweise gibt es ``. +- **Medieneinbindung**: Bilder bindest du über `![Alt-Text](path)` oder `Text` ein, Videos mit `