Repository navigation
docs: explain why a quit-on-close utility can quit OpenScreen on macOS - #1107
Merged
Merged
Conversation
… macOS Utilities such as Vorssaint's "Quit on close" only count windows at the normal level, so they never count the always-on-top HUD. When the HUD hides for Apple's picker, or when OpenScreen's own source window closes, they send a Quit Apple Event and OpenScreen exits cleanly with no crash report (#1021). Add a FAQ entry with the workaround (add OpenScreen to the utility's exceptions) and a log command that names the app that sent the quit request, in English and the seven translations.
People who think OpenScreen crashed land on the README first. Add a short note to the macOS install section, next to the other macOS caveats, naming the quit-on-close utilities and linking the FAQ entry (#1021).
Contributor
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info
📝 Walkthrough
Merge Risk: ⚪ Minimal · up to The added troubleshooting guidance links to the FAQ, and the inspected locale versions preserve its key steps. No material merge risk is established. Pre-merge checks |
 |
| Check name | Status | Explanation |
|---|---|---|
| Title check |  |
The title clearly and concisely describes the main documentation change: explaining how quit-on-close utilities can quit OpenScreen on macOS. |
| Description check | |
The description follows the repository template. It includes a summary, related issue, change type, release impact, desktop impact, screenshots status, and detailed testing information. |
| Docstring Coverage | |
No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0… |
| Linked Issues check | |
Check skipped because no linked issues were found for this pull request. |
| Out of Scope Changes check | |
Check skipped because no linked issues were found for this pull request. |
✨ Finishing Touches
-
🧪 Generate unit tests (beta)
-
- Commit to this branch
- Create a new PR
-
- Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
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 help to get the list of available commands.
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
The "crash" in #1021 is a clean quit requested by another app. Vorssaint's Quit on close option (opt-in, in a popular menu bar toolkit) only counts windows at the normal window level, so it never counts OpenScreen's always-on-top HUD. When the HUD hides for Apple's picker, or when OpenScreen's own source window closes, Vorssaint sends a Quit Apple Event about 1.4 to 1.7 s later. OpenScreen exits with status 0 and no crash report. The full analysis is in this comment on #1021. It was reported upstream as vorssaint/vorssaint-utils#2941.
This PR documents it where users will look:
website/docs/faq.mdand the seven translations): a new entry that covers the cause, the fix (add OpenScreen to the utility's exceptions, or turn the option off), and alog showcommand that names the app that sent a quit request, whatever the utility. The Sources list gains Vorssaint, checked October 2026.Related issue
Refs #1021. It stays open until the reporter confirms the workaround.
Type of change
Release impact
Desktop impact
Screenshots / video
None, text only.
Testing
npm run buildinwebsite/: all 8 locales build. The new heading's anchorwhy-does-openscreen-quit-on-macos-when-i-choose-what-to-recordis present in each locale's FAQ page, so the README link resolves once the site deploys.npm run i18n:checkinwebsite/lists no FAQ translation as behind. The only stale files it reports are theai-editing.mdtranslations, which are already behind onmain.log showcommand in the entry was run on that Mac. It lists Vorssaint's quit requests, and also the one System Settings sends for "Quit & Reopen".Summary by CodeRabbit