Skip to content

docs: permission problem badge + ignore .worktrees#95

Merged
pasrom merged 3 commits intomainfrom
docs/permission-badge
Apr 9, 2026
Merged

docs: permission problem badge + ignore .worktrees#95
pasrom merged 3 commits intomainfrom
docs/permission-badge

Conversation

@pasrom
Copy link
Copy Markdown
Owner

@pasrom pasrom commented Apr 8, 2026

Summary

  • Documents the red exclamation badge that overlays active menu bar icons when Microphone, Screen Recording, or Accessibility is denied or broken
  • README: new "Permission problem badge" subsection with image, per-permission meaning, and the "toggle off/on in System Settings" fix for the broken (TCC out of sync) case
  • docs/architecture-macos.md: new "Permission health check + badge overlay" subsection covering PermissionHealthCheck, the re-check on app activation, MenuBarIcon.image(permissionOverlay:), and the interaction with BadgeKind.compute and notification dedup
  • Extends scripts/generate_menu_bar_gifs.swift with drawExclamationBadge() (mirrored from MenuBarIcon.drawExclamationBadge) and a menu-bar-permission.gif output so the doc image is reproducible
  • Also includes a pre-existing local chore: ignore .worktrees/ directory

Permission problem badge

Test plan

  • swift scripts/generate_menu_bar_gifs.swift regenerates all GIFs including docs/menu-bar-permission.gif
  • README renders correctly on GitHub (image visible, section heading reads "Permission problem badge")
  • docs/architecture-macos.md renders correctly on GitHub

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Apr 8, 2026
@pasrom pasrom force-pushed the docs/permission-badge branch from 368e1e5 to 3ced142 Compare April 8, 2026 20:43
pasrom added 2 commits April 9, 2026 06:37
Adds drawExclamationBadge() mirroring MenuBarIcon.drawExclamationBadge
and a new menu-bar-permission.gif output (idle waveform + red "!" overlay)
so the documentation image can be regenerated deterministically alongside
the other menu bar GIFs.
Explains the red exclamation badge that overlays active menu bar icons
when Microphone, Screen Recording, or Accessibility is denied or broken:

- README: new "Permission problem badge" section with image, meaning of
  each permission state, and the "toggle off/on in System Settings" fix
  for the broken (TCC out of sync) case.
- architecture-macos.md: new "Permission health check + badge overlay"
  section covering PermissionHealthCheck, AppState re-checks on app
  activation, MenuBarIcon.image(permissionOverlay:), and the interaction
  with BadgeKind.compute and notification dedup.
@pasrom pasrom force-pushed the docs/permission-badge branch from 3d48431 to 1d94298 Compare April 9, 2026 04:37
@pasrom pasrom merged commit 3d9ffd9 into main Apr 9, 2026
6 checks passed
@pasrom pasrom deleted the docs/permission-badge branch April 9, 2026 04:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant