Files
immich-folio/.agent/workflows/update-config-docs.md

861 B

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