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.
This commit is contained in:
Will Miao
2026-09-13 07:59:28 +08:00
parent 3592eab48c
commit f88fe2665c
2 changed files with 9 additions and 15 deletions
+8
View File
@@ -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
+1 -15
View File
@@ -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": []
}
}