Koko210/immich-folio
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

chore: add workflow rule for updating documentation whenever user-facing settings change

Browse Source
This commit is contained in:
ralksta
2026-03-08 22:48:06 +01:00
parent a99406c382
commit 6371a60d0a
1 changed files with 11 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
.agent/workflows/update-config-docs.md Normal file
View File

@@ -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.