docs: improve Docker notice with setup steps and example command#1259
docs: improve Docker notice with setup steps and example command#1259lin-bot23 wants to merge 1 commit into
Conversation
📝 WalkthroughWalkthroughChangesDocker notice guidance
Possibly related PRs
🚥 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 |
![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 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
📒 Files selected for processing (1)
snippets/install/docker-notice.mdx
| docker run -d \ | ||
| --name comfyui \ | ||
| -p 8188:8188 \ | ||
| -v /path/to/models:/ComfyUI/models \ | ||
| -v /path/to/output:/ComfyUI/output \ | ||
| <community-image-name> |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟠 Major | ⚡ Quick win
Make the volume paths image-specific.
Community images do not share one container layout. For example, one current image uses /opt/comfyui/models and /opt/comfyui/output, so this command may mount directories that the selected image never reads or writes. A mount that misses its target is just a decorative bind. Document paths for a named image, or explicitly instruct users to replace the container paths according to that image’s documentation. (github.com)
🤖 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 `@snippets/install/docker-notice.mdx` around lines 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.
Source: MCP tools
1 participant
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
Source
Mintlify AI Assistant analytics data (2026-07-14)
Checklist