Skip to content

docs: weekly review 2026-05-14#7

Open
vasylenko wants to merge 1 commit into
mainfrom
docs/weekly-review-2026-05-14
Open

docs: weekly review 2026-05-14#7
vasylenko wants to merge 1 commit into
mainfrom
docs/weekly-review-2026-05-14

Conversation

@vasylenko
Copy link
Copy Markdown
Owner

Weekly documentation review — 2026-05-14

What was reviewed

All user-facing and maintainer-facing docs:

  • README.md — features, requirements, build/verify instructions, tech stack
  • CLAUDE.md — tech stack, project structure, code style, testing, localization, CLI commands, distribution
  • ARCHITECTURE.md — system context diagram, design rationale, constraints, UserDefaults keys, error handling
  • PRD.md — product requirements, scope checklists

Each doc was cross-checked against the actual Swift source files (VigilApp.swift, SleepManager.swift, MenuBarView.swift, Localizable.xcstrings, PrivacyInfo.xcprivacy, VigilTests.swift).

Fixes

ARCHITECTURE.md — system context diagram: SMAppService placed in wrong subtree

The diagram showed SMAppService (login item registration) as a dependency of SleepManager, alongside powerd. In the actual code, SleepManager.swift does not import ServiceManagement and makes no reference to SMAppService. It is MenuBarView.swift that imports ServiceManagement and calls SMAppService.mainApp.register(), .unregister(), and .status.

The diagram now reflects the actual ownership: SMAppService branches off MenuBarView directly, while the SleepManager subtree retains only IOKit → powerd and UserDefaults.


Generated by Claude Code

SMAppService is used by MenuBarView (MenuBarView.swift imports ServiceManagement
and calls SMAppService.mainApp.register/unregister/status), not by SleepManager.
The previous diagram incorrectly placed it in the SleepManager subtree alongside
powerd.
@vercel
Copy link
Copy Markdown

vercel Bot commented May 14, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
vigil Ready Ready Preview, Comment May 14, 2026 0:21am

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant