docs: overhaul README for clarity and added venv instructions#12656
docs: overhaul README for clarity and added venv instructions#12656c0dezer019 wants to merge 4 commits intoComfy-Org:masterfrom
Conversation
c0dezer019
requested review from
Kosinkadink,
comfyanonymous and
guill
as code owners
📝 WalkthroughWalkthroughThis PR updates README.md with structural and formatting changes: it consolidates "Get Started" installation options into a table, adds an Examples link, standardizes and bolds model category headers (Image, Image Editing, Video, Audio, 3D), and reorganizes subsections. Release Process, Shortcuts/Keybinds, and Installing sections are reformatted (tables and clarified descriptions). TLS/SSL, frontend deployment notes, platform GPU/driver guidance, and numerous command/env examples were revised; many inline code fragments were converted to standardized markdown blocks. 🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. 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.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@README.md`:
- Line 340: The README contains a broken internal link "Install the ComfyUI
[dependencies](`#dependencies`)" because the target heading "#dependencies" is
missing; fix it by either adding a matching heading "## Dependencies" (or "###
Dependencies" to fit surrounding TOC level) to the README so the anchor exists,
or change the link target in that sentence to the correct existing heading
(replace "#dependencies" with the actual heading anchor used elsewhere); ensure
the link text "dependencies" and the anchor "#dependencies" are updated
consistently.
Test Evidence CheckIf this PR modifies behavior that requires testing, a test explanation is required. PRs lacking applicable test explanations may not be reviewed until added. Please add test explanations to ensure code quality and prevent regressions. If this PR changes user-facing behavior, visual proof (screen recording or screenshot) is required. PRs without applicable visual documentation may not be reviewed until provided. You can add it by:
|
Restructured the layout for a better look and added specific instructions for venv usage for installing and running.
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@README.md`:
- Line 343: The internal README link with text "you might be able to reuse the
dependencies" points to a non-existent anchor
'#i-already-have-another-ui-for-stable-diffusion-installed-do-i-really-have-to-install-all-of-these-dependencies';
either remove the anchor from the link (leave plain text) in the sentence
"Install the ComfyUI [dependencies](`#instructions`). If you have another Stable
Diffusion UI you might be able to reuse the dependencies." or add a matching FAQ
heading with that exact slug (a subsection title that generates the same anchor)
under the FAQ area (after the existing FAQ section) with content addressing
reuse of dependencies so the link resolves.
There was a problem hiding this comment.
🧹 Nitpick comments (1)
README.md (1)
409-409: Use##here to preserve README heading hierarchy.Line 409 and Line 518 are set to H1 (
#), which breaks the section nesting under the existing top-level title and makes navigation/TOC structure harder to scan.Suggested diff
-# Running +## Running ... -# FAQ +## FAQAs per coding guidelines, "Only comment on issues directly introduced by this PR's code changes."
Also applies to: 518-518
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` at line 409, Change the new top-level headings introduced in this PR from single H1 to H2 to preserve README hierarchy: replace the leading "#" before the "Running" heading (and any other H1 headings added by this PR) with "##" so they become subheadings and maintain the document's section nesting and TOC structure.
🤖 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 409: Change the new top-level headings introduced in this PR from single
H1 to H2 to preserve README hierarchy: replace the leading "#" before the
"Running" heading (and any other H1 headings added by this PR) with "##" so they
become subheadings and maintain the document's section nesting and TOC
structure.
2 participants
Restructured the layout for a better look and added specific instructions for venv usage for installing and running.