docs: add Docker FAQ note to system requirements page#1230
Conversation
|
Warning Review limit reached
Next review available in: 51 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Plus Run ID: 📒 Files selected for processing (5)
📝 WalkthroughWalkthroughA documentation update adds localized Docker notices to installation guides and system requirements pages, and introduces reusable Docker notice snippets in English, Japanese, Korean, and Chinese. ChangesDocker notice documentation
Compact metadata: 16 files changed, docs-only, low review effort. Related issues: None referenced. Related PRs: None referenced. Suggested labels: documentation, i18n Suggested reviewers: None specified No sequence diagram needed — this change is all docs and no dockside drama. Poem: 🚥 Pre-merge checks | ✅ 2✅ Passed checks (2 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
✨ Simplify code
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 |
Clarify that ComfyUI has no official Docker image and that images found on Docker Hub are community-maintained and unsupported. EN/ZH/JA/KO only.
comfyui-wiki
force-pushed
the
analytics-fix/2026-07-06-docker-faq
branch
from
00bda55 to
e102e4b
Compare
Move the Docker disclaimer into install/docker-notice snippets for EN/ZH/JA/KO and reference them from system requirements and manual install only.
Place <DockerNotice /> under a localized FAQ heading at the bottom of system requirements and manual install pages instead of inline.
Refresh translationSourceHash on zh/ja/ko pages and snippet hash comments after system requirements and manual install changes.
Unescaped <= was parsed as JSX and broke mint broken-links validation.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@installation/manual_install.mdx`:
- Around line 91-93: The shared Docker note rendered by the FAQ block still uses
an em dash, which breaks the English docs style rule. Update the shared snippet
used by DockerNotice so its punctuation is a period, colon, or second sentence
instead of an em dash, and verify the change applies to both English MDX docs
that render this component.
In `@installation/system_requirements.mdx`:
- Around line 66-69: The shared Docker notice rendered by the FAQ block uses
punctuation that violates the English MDX style guide. Update the shared snippet
used by DockerNotice so its sentence ends with a period or colon instead of an
em dash, and keep the change in the reusable copy rather than the page-specific
FAQ content.
In `@snippets/install/docker-notice.mdx`:
- Line 2: The Docker notice text in the MDX snippet uses an em dash, which
violates the English documentation style guide. Update the sentence in the
docker notice content to remove the em dash and split it into separate sentences
or use punctuation like a period or colon, keeping the wording associated with
the Docker notice message intact.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro Plus
Run ID: fd69ab09-62f5-4f46-9766-31611365a346
📒 Files selected for processing (12)
installation/manual_install.mdxinstallation/system_requirements.mdxja/installation/manual_install.mdxja/installation/system_requirements.mdxko/installation/manual_install.mdxko/installation/system_requirements.mdxsnippets/install/docker-notice.mdxsnippets/ja/install/docker-notice.mdxsnippets/ko/install/docker-notice.mdxsnippets/zh/install/docker-notice.mdxzh/installation/manual_install.mdxzh/installation/system_requirements.mdx
| ## FAQ | ||
|
|
||
| <DockerNotice /> |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Keep the Docker note punctuation compliant.
This FAQ block renders the same shared English Docker note, so the em dash shows up here too. Please swap it for a period or colon in the shared snippet so both English docs stay within the style guide. As per coding guidelines, **/*.mdx: In English documentation, avoid em dashes (—); use periods, commas, colons, parentheses, or a second sentence instead.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@installation/manual_install.mdx` around lines 91 - 93, The shared Docker note
rendered by the FAQ block still uses an em dash, which breaks the English docs
style rule. Update the shared snippet used by DockerNotice so its punctuation is
a period, colon, or second sentence instead of an em dash, and verify the change
applies to both English MDX docs that render this component.
Source: Coding guidelines
|
|
||
| ## FAQ | ||
|
|
||
| <DockerNotice /> |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Keep the Docker note punctuation compliant.
This FAQ block renders the shared English Docker note, and that copy uses an em dash. Please swap it for a period or colon in the shared snippet so the rendered docs stay within the English MDX style guide. As per coding guidelines, **/*.mdx: In English documentation, avoid em dashes (—); use periods, commas, colons, parentheses, or a second sentence instead.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@installation/system_requirements.mdx` around lines 66 - 69, The shared Docker
notice rendered by the FAQ block uses punctuation that violates the English MDX
style guide. Update the shared snippet used by DockerNotice so its sentence ends
with a period or colon instead of an em dash, and keep the change in the
reusable copy rather than the page-specific FAQ content.
Source: Coding guidelines
Split the English Docker notice into separate sentences to match the English MDX style guide. Refresh snippet translation hashes.
2 participants
Summary
Users frequently ask about Docker installation for ComfyUI (appeared 2+ times in July 5 analytics alone). This PR adds a brief FAQ note to the system requirements page clarifying that no official Docker image is maintained and pointing to community alternatives.
Changes
Source
Mintlify AI Assistant analytics data (2026-07-05)
Checklist