Skip to content

docs(comfyui-plugin): add a skills index, installation, and the finishing-pass gate - #2229

Merged
laurigates merged 1 commit into
mainfrom
docs/comfyui-plugin-readme
Jul 29, 2026
Merged

docs(comfyui-plugin): add a skills index, installation, and the finishing-pass gate#2229
laurigates merged 1 commit into
mainfrom
docs/comfyui-plugin-readme

Conversation

@laurigates

Copy link
Copy Markdown
Owner

What

A /configure:readme audit of comfyui-plugin/README.md, applied against the house plugin-README shape rather than the skill's generic project template.

Audit

Sampled the shape from git-plugin, blueprint-plugin, taskwarrior-plugin, agent-patterns-plugin, foundryvtt-plugin:

Section Status Evidence
Title, description, Overview PASS
Per-skill detail PASS all 17 skills covered (9 sections + 8 grouped)
Skills index table MISSING 4 of 5 siblings have one; this README had 17 skills in prose with no scannable entry point
Installation MISSING 3 of 5 siblings have one
When to Use This Plugin PASS
Badges / logo / tech stack N/A no plugin README in this repo uses them
Content currency STALE described the just assets placeholder guard but not the finishing-pass gate from #2226

Changes

  • Skills index, grouped by job — build/ship a pack · author-verify-publish · work on a graph · pick a node — each row linking to its existing detail section. Row text is taken from each skill's own frontmatter description rather than re-invented, so the index cannot drift from the skill it names.
  • Installation — the marketplace add/install pair, plus the external tools the pack-building skills actually expect (python3, uv, bun, just, rsvg-convert, Docker).
  • Currency for fix(comfyui-plugin): gate the scaffold finishing pass instead of printing it #2226 — documents the pack-CI assertion and the re-runnable scaffold.py --verify verdict, and notes that /comfy-node reads STATUS= before handing back. This is the README update the nudge-plugin-readme-currency hook asked for on that PR; fix(comfyui-plugin): gate the scaffold finishing pass instead of printing it #2226 merged before it was applied, so it lands here.

Deliberately not applied

Badges, a logo block, and a tech-stack table are in the skill's standard template but are skipped: no plugin README in this repo carries them, and a plugin README is an index of skills, not a project landing page. Importing them would have made this file the outlier instead of fixing the way it already was one.

Verification

  • All 10 anchor targets resolve to real headings in the file (checked by parsing headings → GitHub anchor slugs and diffing against the link set).
  • All 17 skills on disk are named in the README — no skill is reachable only by browsing skills/.
  • 266 lines, in line with siblings (266–320).

…hing-pass gate

Three gaps from a /configure:readme audit against the house plugin-README
shape (sampled from git-, blueprint-, taskwarrior-, agent-patterns-plugin):

- **No skills index.** 17 skills documented in prose only, with no scannable
  entry point; 4 of 5 sibling plugin READMEs carry a table. Added one grouped
  by job — build/ship a pack, author-verify-publish, work on a graph, pick a
  node — with each row linking to its existing detail section. Descriptions
  are taken from each skill's own frontmatter rather than re-invented.
- **No installation section.** 3 of 5 siblings have one. Added the marketplace
  add/install pair plus the external tools the pack-building skills expect
  (python3, uv, bun, just, rsvg-convert, Docker).
- **Stale content.** The README described the `just assets` placeholder guard
  but not the finishing-pass gate, so it documented the state of the world
  before the previous commit. Added the pack-CI assertion and the re-runnable
  `--verify` verdict, and noted that /comfy-node reads STATUS= before handing
  back.

Badges, logo, and tech-stack sections from the skill's generic project
template are deliberately skipped: no plugin README in this repo uses them,
and a plugin README is an index of skills, not a project landing page.

Verified: all 10 anchor targets resolve to real headings, and all 17 skills on
disk are named in the README.
@laurigates laurigates added docs Documentation changes comfyui-plugin ComfyUI plugin related labels Jul 29, 2026
@laurigates laurigates self-assigned this Jul 29, 2026
@github-actions

Copy link
Copy Markdown
Contributor

Plugin Compliance Review

Plugin plugin.json Frontmatter Body Marketplace Release Config Bash Patterns Descriptions When-to-Use Size Overall
comfyui-plugin ⚠️ ⚠️ ⚠️

Recommendations

  • ⚠️ comfyui-plugin/comfy-cli: description is 201 chars — over the 200-char target band (see .claude/rules/skill-quality.md)
  • ⚠️ comfyui-plugin/comfy-flow-control: description is 203 chars — over the 200-char target band (see .claude/rules/skill-quality.md)
  • ⚠️ comfyui-plugin/comfy-image-utils: description is 217 chars — over the 200-char target band (see .claude/rules/skill-quality.md)
  • ⚠️ comfyui-plugin/comfy-math-strings: description is 205 chars — over the 200-char target band (see .claude/rules/skill-quality.md)
  • ⚠️ comfyui-plugin/comfy-registry-lifecycle: description is 214 chars — over the 200-char target band (see .claude/rules/skill-quality.md)
  • ⚠️ comfyui-plugin/comfy-subgraphs-app-mode: description is 223 chars — over the 200-char target band (see .claude/rules/skill-quality.md)
  • ⚠️ comfyui-plugin/comfy-workflow-json: description is 217 chars — over the 200-char target band (see .claude/rules/skill-quality.md)
  • ⚠️ comfyui-plugin/comfyui-node-authoring: description is 212 chars — over the 200-char target band (see .claude/rules/skill-quality.md)
  • ⚠️ comfyui-plugin/comfy-debug-preview: SKILL.md is 14660 chars (~3665 tokens, >10000) — consider extracting to REFERENCE.md or scripts/ (ceiling: 26000 chars / ~6500 tokens)
  • ⚠️ comfyui-plugin/comfy-cli: SKILL.md is 17377 chars (~4344 tokens, >10000) — consider extracting to REFERENCE.md or scripts/ (ceiling: 26000 chars / ~6500 tokens)
  • ⚠️ comfyui-plugin/comfy-math-strings: SKILL.md is 15815 chars (~3953 tokens, >10000) — consider extracting to REFERENCE.md or scripts/ (ceiling: 26000 chars / ~6500 tokens)
  • ⚠️ comfyui-plugin/comfyui-node-scaffold: SKILL.md is 21184 chars (~5296 tokens, >10000) — consider extracting to REFERENCE.md or scripts/ (ceiling: 26000 chars / ~6500 tokens)
  • ⚠️ comfyui-plugin/comfy-workflow-json: SKILL.md is 10002 chars (~2500 tokens, >10000) — consider extracting to REFERENCE.md or scripts/ (ceiling: 26000 chars / ~6500 tokens)
  • ⚠️ comfyui-plugin/comfy-registry-lifecycle: SKILL.md is 21831 chars (~5457 tokens, >10000) — consider extracting to REFERENCE.md or scripts/ (ceiling: 26000 chars / ~6500 tokens)
  • ⚠️ comfyui-plugin/comfy-image-utils: SKILL.md is 19626 chars (~4906 tokens, >10000) — consider extracting to REFERENCE.md or scripts/ (ceiling: 26000 chars / ~6500 tokens)
  • ⚠️ comfyui-plugin/comfy-flow-control: SKILL.md is 14343 chars (~3585 tokens, >10000) — consider extracting to REFERENCE.md or scripts/ (ceiling: 26000 chars / ~6500 tokens)
  • ⚠️ comfyui-plugin/comfyui-node-authoring: SKILL.md is 16853 chars (~4213 tokens, >10000) — consider extracting to REFERENCE.md or scripts/ (ceiling: 26000 chars / ~6500 tokens)
  • ⚠️ comfyui-plugin/comfy-node: SKILL.md is 16217 chars (~4054 tokens, >10000) — consider extracting to REFERENCE.md or scripts/ (ceiling: 26000 chars / ~6500 tokens)
  • ⚠️ comfyui-plugin/comfy-workflow-layout: SKILL.md is 10399 chars (~2599 tokens, >10000) — consider extracting to REFERENCE.md or scripts/ (ceiling: 26000 chars / ~6500 tokens)
  • ⚠️ comfyui-plugin/comfy-metadata: SKILL.md is 11190 chars (~2797 tokens, >10000) — consider extracting to REFERENCE.md or scripts/ (ceiling: 26000 chars / ~6500 tokens)
  • ⚠️ comfyui-plugin/comfy-conditionals: SKILL.md is 13361 chars (~3340 tokens, >10000) — consider extracting to REFERENCE.md or scripts/ (ceiling: 26000 chars / ~6500 tokens)

@laurigates
laurigates merged commit 953cba1 into main Jul 29, 2026
4 checks passed
@laurigates
laurigates deleted the docs/comfyui-plugin-readme branch July 29, 2026 18:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

comfyui-plugin ComfyUI plugin related docs Documentation changes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant