From 6371a60d0aafbadb64b93f09ea0a1cab1658cde4 Mon Sep 17 00:00:00 2001 From: ralksta Date: Sun, 8 Mar 2026 22:48:06 +0100 Subject: [PATCH] chore: add workflow rule for updating documentation whenever user-facing settings change --- .agent/workflows/update-config-docs.md | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 .agent/workflows/update-config-docs.md diff --git a/.agent/workflows/update-config-docs.md b/.agent/workflows/update-config-docs.md new file mode 100644 index 0000000..7876608 --- /dev/null +++ b/.agent/workflows/update-config-docs.md @@ -0,0 +1,11 @@ +--- +description: Update documentation when adding user configuration settings +--- + +Wenn du neuen Code hinzufügst, der dem Benutzer erlaubt, neue Einstellungen zu machen (beispielsweise durch Anpassungen an der App oder der Schema-Datei für Eigenschaften): + +1. **Beispiel-Konfiguration aktualisieren:** + Öffne die Datei `content/gallery.yaml.example` (bzw. `content/settings.yaml.example` falls zutreffend) und ergänze dort das neue Feature als auskommentiertes oder fiktives Anwendungsbeispiel, damit User verstehen, was sie dort eintragen können. + +2. **Dokumentation aktualisieren:** + Öffne die Datei `docs/gallery-config.md` (oder vergleichbare Dokus wie `docs/settings-config.md`) und füge eine Erläuterung für die neuen Parameter, ihre Datentypen und deren Wirkung auf die UI hinzu. Gebe wenn möglich Vorher-/Nachher- oder Code-Beispiele an.