malkuthroandClaude Opus 4.7
ee8ccefdf8
Bundles two changes for v0.1.7: 1. PR #36 (already on main, just rolling [Unreleased] -> [0.1.7]): suffix all node display names with " (Koolook)" so they group together in ComfyUI's node-add search. Class IDs unchanged. 2. Docs reorg: - git mv Glossary.md -> docs/reference/glossary.md - git mv RELEASING.md -> docs/maintainers/releasing.md - Three audience buckets under docs/: user_guide/ (end users), reference/ (lookups), maintainers/ (project ops). Each gets a short index README.md. - Top-level docs/README.md as the navigation entry point. - New: docs/maintainers/registry-api.md captures the Comfy Registry undocumented version-management API (deprecate/yank/status enum, auto-deprecation behavior, curl recipes, optional GH Actions workflow YAML for codified mgmt without exposing the token). - New: docs/maintainers/node-versioning.md codifies the rules from the v0.1.5 PR-review discussion for changing INPUT_TYPES / RETURN_TYPES / class names without breaking saved workflows. - Imported the existing untracked docs/ images that the maintainer started locally (node inventory screenshot, Easy Image Batch helper image). - Cross-references updated in README.md, CLAUDE.md, the issue template, and .claude/skills/add-external-fork/SKILL.md. Root drops from 6 -> 4 markdown files. The four that stay (README, LICENSE, CHANGELOG, CLAUDE.md) are the ones that *must* live there for GitHub / Comfy Registry / tooling / Claude Code reasons. Co-authored-by: Claude Opus 4.7 <noreply@anthropic.com>
1.2 KiB
1.2 KiB
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 |
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 |