Reorganize docs/investigations/ into numbered topic folders, each
self-contained with narrative + upstream pin + patches + per-run snapshots.
Add a generic sync helper that mirrors the dev-sync pattern for any
investigation's third-party node modifications.
Structure (new):
docs/investigations/
00_LTX23-base-1-step/README.md (rename of ltx-director-4k-transitions.md)
01_LTX23-audio-file-lipsync/
README.md -- problem, mechanism, patches, reversion, promotion
upstream.json -- repo + version + pinned commit + sync target env + files
patches/ -- source of truth for modified upstream files
ltx_director.py -- adds `relay_overrides` multiline JSON input
prompt_relay.py -- per-segment sigma per Prompt-Relay paper formula
runs/
LOOP.md -- iteration protocol
log.md -- rolling table (empty header for now)
Sync helper:
scripts/sync_investigation_patches.py <NN>_<topic> [--dry-run]
- Reads upstream.json for target env var + file list
- Backs up the target's current state once per day (<file>.bak.<YYYYMMDD>)
- Worktree-aware: falls back to MAIN's .env via git rev-parse --git-common-dir
- Prints a two-line report matching scripts/sync_to_dev.py shape
- Per-investigation trigger phrase via `trigger:` key (sync-audio for #177)
Env:
.env.example -- documents new KOLOOK_WHATDREAMSCOST_PATH
.env -- local path set
Glossary updates (docs/reference/glossary.md):
+ Investigation folder
+ JSON file folder
+ Loop
+ Run
+ Investigation patches
+ sync_investigation_patches.py
Closes the workflow gap from #177: MAIN is now the source of truth for
investigation patches; the live install is a sync destination only. No
manual file copying between iterations — `sync-audio` does it.
ComfyUI-Koolook documentation
Three audience buckets — pick where to look based on what you're trying to do.
| If you want to … | Go to | One-line description |
|---|---|---|
| Use a node in your ComfyUI workflow | user_guide/ |
Per-node guides, screenshots, recipes |
| Look something up — a term, a node ID, a list | reference/ |
Glossary, node inventory, spec sheets |
| Cut a release / fork a node / debug CI / hit the Comfy Registry API | maintainers/ |
Releasing, Registry API, Node versioning rules |
| Compare UI design proposals before implementation | designs/ |
Focused mockups and screenshots for in-progress UX decisions |
| Run AI-assisted model evaluation loops | automations/ |
Visual loop overview, setup contract, per-model findings, and /make-card workflow |
Files that intentionally stay at the repo root
| File | Why it's not in docs/ |
|---|---|
../README.md |
GitHub repo home + Comfy Registry pulls description from here |
../LICENSE |
pyproject.toml references it; GitHub recognizes the license badge from this path only |
../CHANGELOG.md |
Changelog parsers and release tooling expect it at root |
../CLAUDE.md |
Claude Code reads project-level agent instructions from <repo>/CLAUDE.md |