docs: weekly review 2026-06-25#8
Open
vasylenko wants to merge 1 commit into
Open
Conversation
…cy policy privacy.html stated the launch-at-login setting is stored via UserDefaults, but SleepManager's DefaultsKey enum has no such key — it's managed entirely through SMAppService (ServiceManagement framework / OS login-item system). ARCHITECTURE.md's UserDefaults Keys table already reflects this correctly (rememberLastState, wasActiveAtQuit, sleepMode only); privacy.html did not.
|
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. Inventoried user-facing docs (
website/index.html,website/privacy.html,website/support.html) and maintainer-facing docs (README.md,ARCHITECTURE.md,PRD.md,CLAUDE.md), then cross-checked every factual claim against the current codebase (SleepManager.swift,MenuBarView.swift,VigilApp.swift,PrivacyInfo.xcprivacy,Localizable.xcstrings,project.pbxproj, CI workflow). Found one factual inaccuracy in the privacy policy and fixed it; everything else checked out.Changes
website/privacy.html— Local Storage section incorrectly claimed the "launch-at-login setting" is stored in macOS UserDefaults alongside sleep mode and last-active-state. In the actual code, launch-at-login is managed entirely throughSMAppService(the ServiceManagement framework / OS login-item system) — seeMenuBarView.swift(launchAtLoginstate synced fromSMAppService.mainApp.status, toggled viaregister()/unregister()).SleepManager.swift'sDefaultsKeyenum only has three keys (rememberLastState,sleepMode,wasActiveAtQuit) and none relate to login items.ARCHITECTURE.md's own UserDefaults Keys table already reflects this correctly, so this was a cross-document consistency gap as well as a factual error. Split the sentence to accurately attribute each piece of stored state to its actual storage mechanism.No Issues Found
CLAUDE.md's Project Structure tree (app/Vigil.xcodeproj/,app/Vigil/,app/VigilTests/) matches the actual directory layout. Entry point (AppLauncherinVigilApp.swift), menu bar SF Symbol (light.beacon.max.fill), andMenuBarExtra(.window)style all match code exactly.PrivacyInfo.xcprivacydeclares onlyNSPrivacyAccessedAPICategoryUserDefaults(reasonCA92.1), matchingCLAUDE.md/ARCHITECTURE.md.Localizable.xcstringshas source languageenplusde,es,hi,uk,zh-Hans— matches the Localization section's language list exactly.README.md(Display & System vs System Only, display/system sleep blocked/allowed) matchesSleepManager.swift'sSleepModeassertion types.ARCHITECTURE.md's Assertion Behavior Matrix and Error Handling table are consistent with the implementation.xcodebuildcommands inCLAUDE.mdand the verify command (pmset -g assertions | grep Vigil) are accurate and reproducible against the current Xcode project.project.pbxprojis a generic Xcode-generated value, but the target-level setting (the one that actually applies to the Vigil app/test targets) is15.6, matching all docs.ARCHITECTURE.md's Key Technical Constraints table (sandbox,LSUIElement, MainActor isolation, Bundle ID,PRODUCT_NAME) matches the project settings andCLAUDE.md.README.md,CLAUDE.md, andwebsite/index.html. Two-mode behavior description is consistent acrossREADME.md,ARCHITECTURE.md, andwebsite/index.html. (The one inconsistency found —privacy.htmlvs.ARCHITECTURE.mdon launch-at-login storage — is the fix above.)Generated by Claude Code