docs: add FAQ entry for checking startup logs in Comfy Desktop#1258
Open
lin-bot23 wants to merge 1 commit into
Open
docs: add FAQ entry for checking startup logs in Comfy Desktop#1258lin-bot23 wants to merge 1 commit into
lin-bot23 wants to merge 1 commit into
Conversation
📝 WalkthroughWalkthroughChangesDesktop FAQ updates
🚥 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: 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/desktop/faq.mdx`:
- Line 96: Update the Linux entry in the FAQ to include a supported, copyable
launch command or a direct reference to the Linux log location. Keep the
existing real-time logging guidance while making the instruction actionable for
users.
- Around line 85-99: Remove the leading pipe characters from every line inside
the Accordion titled “How do I check Comfy Desktop startup logs?”, including the
platform instructions, code fences, and closing tag, so the content uses normal
MDX/Markdown formatting.
- Around line 100-104: Update the uninstall FAQ accordion content to avoid
claiming the listed steps “fully” remove Comfy Desktop; either change that
wording to “To uninstall the app and installations” or add the documented macOS
cleanup paths and warnings for remaining settings, logs, shared models, and
outputs.
🪄 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: bcbb20f8-c6e3-4f4b-9261-7acb1099db81
📒 Files selected for processing (1)
installation/desktop/faq.mdx
Comment on lines
+85
to
+99
| |<Accordion title="How do I check Comfy Desktop startup logs?"> | ||
| |When Comfy Desktop fails to start or behaves unexpectedly, you can check the startup logs: | ||
| | | ||
| |- **Windows:** Open File Explorer and navigate to `%APPDATA%\Comfy-Desktop\logs\`. Look for the most recent `.log` file. You can also run Comfy Desktop from the command line to see real-time output: | ||
| | ```powershell | ||
| | & "C:\Program Files\Comfy-Desktop\Comfy Desktop.exe" | ||
| | ``` | ||
| |- **macOS:** Open Terminal and run: | ||
| | ```bash | ||
| | /Applications/Comfy\ Desktop.app/Contents/MacOS/Comfy\ Desktop | ||
| | ``` | ||
| |- **Linux:** Open a terminal and run the app from the command line to see logs in real time | ||
| | | ||
| |For ComfyUI engine-level logs (not the Desktop app), check the console output when launching a ComfyUI instance from the Desktop app. You can see it in the instance's **Logs** tab. | ||
| |</Accordion> |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟠 Major | ⚡ Quick win
Remove the leading | characters from the MDX block.
The new Accordion content is pipe-prefixed, unlike the surrounding Markdown. This can make the block render as pipe-delimited text instead of a normal MDX Accordion. Use unprefixed Markdown/MDX lines.
🤖 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/desktop/faq.mdx` around lines 85 - 99, Remove the leading pipe
characters from every line inside the Accordion titled “How do I check Comfy
Desktop startup logs?”, including the platform instructions, code fences, and
closing tag, so the content uses normal MDX/Markdown formatting.
| | ```bash | ||
| | /Applications/Comfy\ Desktop.app/Contents/MacOS/Comfy\ Desktop | ||
| | ``` | ||
| |- **Linux:** Open a terminal and run the app from the command line to see logs in real time |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟠 Major | ⚡ Quick win
Make the Linux instructions actionable.
This line tells users to run the app but provides neither an executable command nor a log path. Add the supported Linux launch command or link to the Linux log location.
🤖 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/desktop/faq.mdx` at line 96, Update the Linux entry in the FAQ
to include a supported, copyable launch command or a direct reference to the
Linux log location. Keep the existing real-time logging guidance while making
the instruction actionable for users.
Comment on lines
+100
to
+104
| |<Accordion title="How do I uninstall Comfy Desktop?"> | ||
| |Comfy Desktop and its installations are separate on disk. To fully remove: | ||
| | | ||
| |1. **Delete the installations** from within the app (right-click → Remove) or delete the installation folders manually | ||
| |2. **Uninstall the app** using your system's standard method (Add/Remove Programs on Windows, drag to Trash on macOS, package manager on Linux) |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟠 Major | ⚡ Quick win
Do not claim this “fully” removes the application yet.
The macOS guide documents that uninstall leaves app settings, logs, shared models, and outputs behind at ~/Library/Application Support/Comfy Desktop and ~/ComfyUI-Shared. Add OS-specific cleanup steps and warnings, or change “To fully remove” to “To uninstall the app and installations.”
🤖 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/desktop/faq.mdx` around lines 100 - 104, Update the uninstall
FAQ accordion content to avoid claiming the listed steps “fully” remove Comfy
Desktop; either change that wording to “To uninstall the app and installations”
or add the documented macOS cleanup paths and warnings for remaining settings,
logs, shared models, and outputs.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Users asking 'how to check startup logs' on the docs homepage could not find relevant information. This adds a dedicated FAQ entry in the Comfy Desktop FAQ explaining how to access startup logs on Windows, macOS, and Linux.
Changes
Source
Mintlify AI Assistant analytics data (2026-07-14)
Checklist