Skip to content

docs: improve Docker notice with setup steps and example command#1259

Open
lin-bot23 wants to merge 3 commits into
Comfy-Org:mainfrom
lin-bot23:analytics-fix/2026-07-14-docker-notice-improvement
Open

docs: improve Docker notice with setup steps and example command#1259
lin-bot23 wants to merge 3 commits into
Comfy-Org:mainfrom
lin-bot23:analytics-fix/2026-07-14-docker-notice-improvement

Conversation

@lin-bot23

Copy link
Copy Markdown
Contributor

Summary

Multiple users asked about Docker installation on the docs homepage and installation pages. The existing Docker notice was too vague ('search Docker Hub') and did not provide actionable guidance. This update adds specific search terms, common setup steps (port mapping, volume mounts), and a Docker run command example.

Changes

  • snippets/install/docker-notice.mdx: expanded the Docker notice with search terms, setup steps, and a docker run example

Source
Mintlify AI Assistant analytics data (2026-07-14)

Checklist

  • English only (translations separate)
  • PR created by Hermes Agent (bot), do not merge

@coderabbitai

coderabbitai Bot commented Jul 13, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

@lin-bot23, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 23 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

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 configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 1b9b44b8-5d02-4cb0-8920-47fef6ee8f7c

📥 Commits

Reviewing files that changed from the base of the PR and between 5139ac5 and da785c1.

📒 Files selected for processing (1)
  • snippets/install/docker-notice.mdx
📝 Walkthrough

Walkthrough

Changes

Docker notice guidance

Layer / File(s) Summary
Community image setup guidance
snippets/install/docker-notice.mdx
Adds common port and volume mappings, a docker run example, and a disclaimer that community images are not official or supported by the ComfyUI team. A handy container tip, ship-shape.

Possibly related PRs

  • Comfy-Org/docs#1230: Imports the shared Docker notice snippet into system requirements and manual installation documentation.
🚥 Pre-merge checks | ✅ 2
✅ Passed checks (2 passed)
Check name Status Explanation
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
✨ Simplify code
  • Create PR with simplified 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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 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 `@snippets/install/docker-notice.mdx`:
- Around line 11-16: Update the Docker example in the installation notice to use
container volume paths specific to the documented community image, or clearly
instruct users to replace /ComfyUI/models and /ComfyUI/output with the paths
required by their selected image. Ensure the example’s mounts target directories
the named image actually uses.
🪄 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: 9f3b3b55-8630-4716-b5c4-fafef2ebf14f

📥 Commits

Reviewing files that changed from the base of the PR and between 36378b6 and 5139ac5.

📒 Files selected for processing (1)
  • snippets/install/docker-notice.mdx

Comment thread snippets/install/docker-notice.mdx
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant