From f88fe2665c96d0f70896c0258ee599f31965b854 Mon Sep 17 00:00:00 2001
From: Will Miao <willmiao.dev@gmail.com>
Date: Sun, 13 Sep 2026 07:59:28 +0800
Subject: [PATCH] chore: keep settings.json.example minimal and document the
 rule

The example now only carries use_portable_settings, civitai_api_key and the
four core folder_paths keys (loras/checkpoints/unet/embeddings). Optional keys
such as the other-model folders, default_*_root and auto_organize_exclusions
are removed; their defaults live in DEFAULT_SETTINGS and reach the user's
settings.json on demand.

AGENTS.md now forbids adding optional/default keys to the example unless the
user explicitly asks for it.
---
 AGENTS.md             |  8 ++++++++
 settings.json.example | 16 +---------------
 2 files changed, 9 insertions(+), 15 deletions(-)

diff --git a/AGENTS.md b/AGENTS.md
index 0a07b3f4..76e96801 100644
--- a/AGENTS.md
+++ b/AGENTS.md
@@ -190,6 +190,8 @@ The system runs in two modes:
 
 - `py/config.py` manages folder paths for models and handles symlink mappings
 - Auto-saves paths to `settings.json` in ComfyUI mode
+- `settings.json.example` is intentionally minimal (see Important Notes); all
+  other defaults live in `DEFAULT_SETTINGS` (`py/services/settings_manager.py`)
 
 ### Frontend UI Architecture
 
@@ -250,6 +252,12 @@ If a cross-layer issue ever needs a live server, the sandboxed helpers live in
 ## Important Notes
 
 - ALWAYS use English for comments (per copilot-instructions.md)
+- **`settings.json.example` must stay minimal**: only `use_portable_settings`,
+  `civitai_api_key`, and the four core `folder_paths` keys (`loras`,
+  `checkpoints`, `unet`, `embeddings`). Do NOT add optional/default keys
+  (model-category folders, `default_*_root`, `auto_organize_exclusions`, etc.)
+  to this file unless the user explicitly asks for it. Defaults belong in
+  `DEFAULT_SETTINGS` in `py/services/settings_manager.py`.
 - Run `python scripts/sync_translation_keys.py` after adding UI strings to `locales/en.json`
 - Symlinks require normalized paths.
   **Business paths vs real paths**: All stored paths and operation routing use the
diff --git a/settings.json.example b/settings.json.example
index ba09276a..bf3d4b89 100644
--- a/settings.json.example
+++ b/settings.json.example
@@ -17,20 +17,6 @@
     "embeddings": [
       "C:/path/to/your/embeddings_folder",
       "C:/path/to/another/embeddings_folder"
-    ],
-    "vae": [
-      "C:/path/to/your/vae_folder"
-    ],
-    "upscale_models": [
-      "C:/path/to/your/upscale_models_folder"
-    ],
-    "text_encoders": [
-      "C:/path/to/your/text_encoders_folder"
-    ],
-    "clip_vision": [
-      "C:/path/to/your/clip_vision_folder"
     ]
-  },
-  "default_other_roots": {},
-  "auto_organize_exclusions": []
+  }
 }