* feat(sidebar): add onboarding guide * docs(guide): clarify tag search casing * docs(guide): clarify workflow save copy * docs(guide): refine sidebar visuals * docs(guide): refresh save snapshot visual * docs(guide): refresh load snapshot visual * docs(guide): refresh module save visual * docs(guide): use real sidebar screenshot * docs(guide): render sidebar overview screenshot directly * docs(guide): soften sidebar overview annotations * docs(guide): clarify nodes action bar callout * docs(guide): clarify workflow action bar callout * docs(guide): simplify sidebar overview markers * docs(guide): align sidebar overview intro * docs(guide): use real snapshot recipe screenshots * docs(guide): simplify project workflow diagram * docs(guide): make function cards scannable * docs(guide): sketch module recipe icon focus * docs(guide): use real icon screenshot for module recipe * docs(guide): add cropped workflow action screenshot * docs(guide): use full toolbar screenshot for module recipe * docs(guide): use real search screenshot * docs(guide): use real node search screenshot * docs(guide): standardize screenshot recipe cards * docs(guide): tighten recipe callout styling * docs: require visual QA for UI work * docs(guide): address pass-2 review nits
Forks Workflow
This folder is the single source for all fork tracking metadata inside MAIN.
Purpose
- Keep modified forked code in MAIN under versioned paths (for GitHub tracking).
- Keep raw external checkouts outside MAIN under
../ComfyUI-Forks(for upstream reference/sync). - Keep all fork metadata in one place:
forks/forks_manifest.yamlforks/THIRD_PARTY.md
Folder Layout in MAIN
forks/radiance_koolook/__init__.py-> package entrypoint used by root__init__.pyforks/radiance_koolook/versions/v1_0_1/-> local modified node sourcesforks/radiance_koolook/versions/<version>/UPSTREAM_PIN.yaml-> exact upstream parity pin
External Folder Naming (outside MAIN)
Root: ../ComfyUI-Forks
- Pinned baseline checkout:
radiance-v1.0.1-koolook
- Rolling upstream checkout:
radiance-main-upstream
These names are referenced from forks/forks_manifest.yaml.
Referencing System
For each fork entry in forks/forks_manifest.yaml:
source_repo= canonical upstream URLsource_ref= release/tag (or baseline descriptor)pinned_commit= exact reproducible commit hashexternal_checkout.relative_path_from_forks_root= pinned raw reference folderexternal_checkout.upstream_tracking_path_from_forks_root= rolling upstream folderlocal_paths= files tracked in MAIN
Tagging Policy (from now on)
- MAIN repo tags use SemVer:
vMAJOR.MINOR.PATCH. - Local fork version folders use underscore variant of the same version:
v1_0_1,v2_3_3, etc.
- Node mapping namespace suffixes must match folder versions:
__koolook_v1_0_1,__koolook_v2_3_3, etc.
- Keep
source_ref+pinned_commitinforks/forks_manifest.yamlandUPSTREAM_PIN.yaml.
Upgrade Flow Example (Radiance)
- Compare current local version (
forks/radiance_koolook/versions/v1_0_1) with pinned raw baseline (../ComfyUI-Forks/radiance-v1.0.1-koolook). - Pull latest upstream in
../ComfyUI-Forks/radiance-main-upstream. - Create a new local version folder in MAIN, e.g.
forks/radiance_koolook/versions/v2_3_3. - Port/validate modifications.
- Namespace node IDs for that version.
- Add new entry/update metadata in
forks/forks_manifest.yaml.
Rule of Thumb
- If it is modified production code -> keep in MAIN under
forks/.../versions/... - If it is raw upstream reference -> keep outside MAIN under
../ComfyUI-Forks