malkuthro
27705be037
* 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
57 lines
2.5 KiB
Markdown
57 lines
2.5 KiB
Markdown
# User Guide
|
|
|
|
End-user documentation for nodes shipped by `ComfyUI-Koolook`. Pages
|
|
mirror the ComfyUI category each node lives under, so the structure here
|
|
matches what you see when you type "koolook" in the node-add menu.
|
|
|
|
Each per-node page includes a **Source** block at the top that records
|
|
whether the node is Koolook-native or imported from a fork — so fork
|
|
attribution is visible without needing a fork-shaped directory tree.
|
|
|
|
## Browse by category
|
|
|
|
| ComfyUI menu | Status | Nodes |
|
|
|---|---|---|
|
|
| `Koolook/Pipeline` | 🚧 page TBD | `EasyAIPipeline` |
|
|
| `Koolook/Image` | 🚧 page TBD | `EasyResize_Koolook`, `easy_ImageBatch` |
|
|
| `Koolook/Camera` | 🚧 page TBD | `KoolookLoadCameraPosesAbsolute` |
|
|
| `Koolook/Wan_Video` | 🚧 page TBD | `EasyWan22Prompt` |
|
|
| `Koolook/VAE` | ✅ [`nodes/radiance_koolook_v2_3_3/`](nodes/radiance_koolook_v2_3_3/) | `Easy_hdr_VAE_encode`, `Easy_hdr_VAE_decode` |
|
|
|
|
## Cross-cutting concepts
|
|
|
|
Pages here cover ideas that span more than one node:
|
|
|
|
- [Kforge Labs sidebar guide](../../web/guide/index.html) — visual onboarding for
|
|
Snapshots, favorite nodes, saved workflows, reusable modules, tags, and recovery.
|
|
- [VAE encode/decode pairing](nodes/radiance_koolook_v2_3_3/encode_decode_pairing.md) — which
|
|
encoder fields must match the decoder for a clean roundtrip, with
|
|
worked examples for SDR / HDR / cinema-log / video workflows.
|
|
- [HDR modes deep dive](nodes/radiance_koolook_v2_3_3/hdr_modes.md) — what `Clip (SDR)`,
|
|
`Soft Clip`, `Compress (Log)`, and `Passthrough` actually do to your
|
|
pixels before they hit the VAE, with per-pixel worked examples.
|
|
|
|
## When to add a guide
|
|
|
|
A node deserves a page if it has any of:
|
|
|
|
- Non-obvious input semantics (e.g. aspect-ratio strings, frame indexing
|
|
conventions).
|
|
- A workflow recipe more useful than the per-input tooltips.
|
|
- A known limitation or compatibility caveat.
|
|
- An encode/decode or input/output pairing relationship with other nodes.
|
|
|
|
Convention:
|
|
|
|
- One markdown file per canonical node ID, named after the ID
|
|
(`easy_hdr_vae_encode.md`, `easy_image_batch.md`).
|
|
- Place it in the folder that matches the node's ComfyUI category.
|
|
- Screenshots and helper images go in [`img/`](img/), named to match the
|
|
page they're embedded in (e.g. `easy_hdr_vae_encode_pairing.png`).
|
|
|
|
## Where to find the canonical node ID list
|
|
|
|
The repo [`README.md`](../../README.md) lists all currently-registered
|
|
node IDs and display names. The historical inventory (including removed
|
|
nodes) is in the [`CHANGELOG.md`](../../CHANGELOG.md).
|