docs: weekly review 2026-07-09#9
Open
vasylenko wants to merge 1 commit into
Open
Conversation
…rDefaults The Local Storage section incorrectly grouped the launch-at-login setting alongside sleep mode and last active state as UserDefaults-stored preferences. In reality, launch-at-login is managed by the macOS ServiceManagement framework via SMAppService.mainApp.register()/unregister() in MenuBarView.swift — it never touches UserDefaults. SleepManager.DefaultsKey only has three keys: sleepMode, rememberLastState, and wasActiveAtQuit.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
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
2 participants
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
Weekly documentation review for vigil. Audited all maintainer-facing docs (
README.md,ARCHITECTURE.md,PRD.md,CLAUDE.md) and user-facing docs (website/privacy.html,website/index.html,website/support.html) against the current codebase (SleepManager.swift,MenuBarView.swift,VigilApp.swift,VigilTests.swift). Found one factual inaccuracy in the privacy policy.Changes
website/privacy.html— Local Storage section incorrectly attributes launch-at-login to UserDefaults → fixed: The section listed "launch-at-login setting" alongside sleep mode and last active state as preferences stored in macOS UserDefaults. In the actual code,SleepManager.DefaultsKeyonly has three keys (sleepMode,rememberLastState,wasActiveAtQuit) — none related to login items. Launch-at-login is managed entirely bySMAppService.mainApp.register()/unregister()inMenuBarView.swift(ServiceManagement framework). Rewrote the paragraph to accurately separate the two storage mechanisms.No Issues Found
The following checklist areas were checked and found accurate:
AppLauncheras@mainentry point withNSClassFromString("XCTestCase")test detection,light.beacon.max.fillSF Symbol,MenuBarExtra(.window)style,@Observableclass pattern — all match code exactly.PrivacyInfo.xcprivacydeclaresNSPrivacyAccessedAPICategoryUserDefaults(reasonCA92.1), matchingCLAUDE.mdandARCHITECTURE.md. UserDefaults key table inARCHITECTURE.md(rememberLastState,wasActiveAtQuit,sleepMode) matchesSleepManager.DefaultsKeyexactly.README.mdandARCHITECTURE.md(Display & System vs System Only, idle/display sleep blocked/allowed) matchSleepManager.swift's assertion types. Error handling table matches theif isActiveguard indeactivate()andtry?on SMAppService calls.CLAUDE.md, verify command (pmset -g assertions | grep Vigil), and assertion reason strings inREADME.mdmatch the actualSleepMode.assertionReasonvalues inSleepManager.swift.PreventUserIdleDisplaySleepcovering both idle and display sleep;@ObservableoverObservableObject;MenuBarExtra(.window)over.menu;try?on SMAppService calls) all consistent with the implementation.serhiivasylenko.vigil) are stated consistently acrossREADME.md,CLAUDE.md,ARCHITECTURE.md, andwebsite/index.html.Generated by Claude Code