Update README (CORE-144)#13679
Conversation
alexisrolland
requested review from
Kosinkadink,
comfyanonymous,
guill,
kijai and
rattus128
as code owners
Updated the README to include a new screenshot and improved description.
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
📝 WalkthroughWalkthroughThe README hero tagline was changed to “powerful and modular AI engine for content creation.” The markdown screenshot was replaced by an HTML 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Tip 💬 Introducing Slack Agent: The best way for teams to turn conversations into code.Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.
Built for teams:
One agent for your entire SDLC. Right inside Slack. 👉 Get your free trial and get 200 agent minutes per Slack user (a $50 value). Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (3)
README.md (3)
42-42: ⚡ Quick win“Production pipelines” framing should include a security caveat/pointer.
Line [42] claims the API endpoints “integrate seamlessly into production pipelines,” but the provided OpenAPI context notes that the
Comfy-Userheader “is not a security mechanism” (no authentication/authorization behind it). Even if you don’t want to fully explain auth in the hero, adding a brief pointer/caveat to the API/security documentation would prevent a common misunderstanding about what “production-ready” means in multi-user contexts.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` at line 42, Update the hero line "It integrates seamlessly into production pipelines with our API endpoints." to add a brief security caveat and a pointer to the API/security docs: mention that the Comfy-User header is not an authentication mechanism and recommend consulting the API/security section for recommended authentication and authorization practices; ensure the text concisely warns about multi-user production use and links or references the OpenAPI/security documentation.
39-39: ⚡ Quick winAlign the API-nodes bullet with the documented “optional/disable” behavior.
Line [39] says API nodes provide access to closed-source models, but it doesn’t mention that API nodes are optional (and can be disabled with
--disable-api-nodes, which is documented elsewhere in this same README). Add a short qualifier or link so the hero copy matches the actual behavior users will encounter.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` at line 39, Update the README sentence that currently reads "API nodes provide access to the best closed source models such as Nano Banana, Seedance, Hunyuan3D, etc." to mention that API nodes are optional and can be disabled; specifically, change or append that sentence (the "API nodes provide access..." hero copy) to include a short qualifier like "optional (can be disabled with --disable-api-nodes)" or a link to the README section that documents the --disable-api-nodes flag so the hero text matches the actual behavior users will encounter.
37-42: ⚡ Quick winTighten unverifiable marketing claims (avoid “latest” / “best”).
The new hero paragraph/bullets use very absolute phrasing (“latest … state of the art” and “best closed source models”). This tends to go stale quickly and can mislead compared to how model support typically works in ComfyUI.
Consider rewording to something less brittle (e.g., “supports a wide range of state-of-the-art open-source models” / “access to closed-source models via API nodes”) and/or linking to the actual canonical support lists/docs.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` around lines 37 - 42, Replace the absolute marketing phrases in the README hero and bullets: change the sentence containing "ComfyUI natively supports the latest open-source state of the art models." to a more measured phrasing like "ComfyUI supports a wide range of state-of-the-art open-source models," and change the bullet "API nodes provide access to the best closed source models such as Nano Banana, Seedance, Hunyuan3D, etc." to something like "API nodes provide access to closed-source models via API integrations." Also update any other absolute claims (e.g., "The most sophisticated workflow...") to less superlative language and add a pointer to the canonical support list or docs (e.g., "see supported models in our docs") so readers can verify current compatibility.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@README.md`:
- Line 42: Update the hero line "It integrates seamlessly into production
pipelines with our API endpoints." to add a brief security caveat and a pointer
to the API/security docs: mention that the Comfy-User header is not an
authentication mechanism and recommend consulting the API/security section for
recommended authentication and authorization practices; ensure the text
concisely warns about multi-user production use and links or references the
OpenAPI/security documentation.
- Line 39: Update the README sentence that currently reads "API nodes provide
access to the best closed source models such as Nano Banana, Seedance,
Hunyuan3D, etc." to mention that API nodes are optional and can be disabled;
specifically, change or append that sentence (the "API nodes provide access..."
hero copy) to include a short qualifier like "optional (can be disabled with
--disable-api-nodes)" or a link to the README section that documents the
--disable-api-nodes flag so the hero text matches the actual behavior users will
encounter.
- Around line 37-42: Replace the absolute marketing phrases in the README hero
and bullets: change the sentence containing "ComfyUI natively supports the
latest open-source state of the art models." to a more measured phrasing like
"ComfyUI supports a wide range of state-of-the-art open-source models," and
change the bullet "API nodes provide access to the best closed source models
such as Nano Banana, Seedance, Hunyuan3D, etc." to something like "API nodes
provide access to closed-source models via API integrations." Also update any
other absolute claims (e.g., "The most sophisticated workflow...") to less
superlative language and add a pointer to the canonical support list or docs
(e.g., "see supported models in our docs") so readers can verify current
compatibility.
Updated the screenshot in the README to a new image.
3 participants
Uh oh!
There was an error while loading. Please reload this page.