Skip to content

docs: add screenshots of the menu bar app to the README - #97

Merged
guhcostan merged 1 commit into
mainfrom
claude/magical-davinci-m4n040
Oct 2, 2026
Merged

guhcostan merged 1 commit into
mainfrom
claude/magical-davinci-m4n040

Conversation

@guhcostan

Copy link
Copy Markdown
Owner

What does this PR do?

  • Adds screenshots of the menu bar app to the README (light and dark, picked automatically with <picture> + prefers-color-scheme):
    • app-*.png: the popover under the menu bar icon (space freed, disk, last run, next automatic clean)
    • app-tour-*.png: Deep Clean asking to confirm a hard delete, History with a run expanded, and Settings
  • Adds bun run screenshots in desktop/. Playwright renders the real renderer (dist/renderer) inside a mock macOS desktop (scripts/screenshots/stage.html) with sample data and a fixed clock, so the screenshots can be regenerated whenever the UI changes.
  • Refreshes the README:
    • expands the app section (features, safety, Full Disk Access);
    • adds dry run, backups, scripting and the menu bar app to the Features table;
    • adds rows to the comparison table;
    • documents app install and --dry-run.
  • Adds the tour screenshot and the screenshots docs to desktop/README.md, plus a CHANGELOG entry.

Type of change

  • Documentation
  • Bug fix
  • New feature
  • Breaking change

Related issue

None.

Checklist

  • bun run lint passes
  • Desktop typecheck and tests pass (42 tests)
  • Screenshots reviewed visually in both themes

Notes for reviewer

  • All the data in the screenshots is sample data.
  • playwright is a desktop devDependency used only by the screenshots script. It doesn't affect the app bundle.
  • The four PNGs are about 3.2 MB in total.

🤖 Generated with Claude Code

https://claude.ai/code/session_01QnDqAyRdicRYnwAAXydYoB


Generated by Claude Code

- Light and dark screenshots of the popover (home) and a tour of Deep
  Clean, History and Settings, shown with <picture> so GitHub picks the
  one matching the reader's theme.
- `bun run screenshots` in desktop/ regenerates them: Playwright renders
  the real renderer inside a mock macOS desktop with sample data.
- README: refreshed the app section, features and comparison tables,
  documented `app install` and `--dry-run`.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01QnDqAyRdicRYnwAAXydYoB

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: d4881571a2

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread README.md
Comment on lines +64 to +65
<source media="(prefers-color-scheme: dark)" srcset="assets/screenshots/app-dark.png">
<img src="assets/screenshots/app-light.png" alt="Mac Cleaner menu bar app: space freed, disk usage, last run and next automatic clean" width="620">

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Use publish-safe URLs for the screenshots

When this README is rendered from the published npm package, these repository-relative paths cannot resolve: package.json publishes only dist, README.md, and LICENSE, so none of the screenshot assets are included. This repository previously changed the banner and demo to raw.githubusercontent.com URLs specifically so npm could render them; use equivalent absolute URLs for all four new screenshot references.

Useful? React with 👍 / 👎.

Comment on lines +23 to +26
const at = (daysAgo, hour, minute = 0) => {
const d = new Date(NOW);
d.setDate(d.getDate() - daysAgo);
d.setHours(hour, minute, 0, 0);

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Make fixture timestamps independent of the host time zone

When the screenshot command runs on a non-UTC machine, these local-time setters, together with the offset-free NOW, create different instants based on the host timezone, while the Playwright page is explicitly forced to UTC. For example, on a Mac in America/Los_Angeles, the intended 10:00 run is displayed as 5:00 PM and disagrees with the hard-coded 10:24 AM menu-bar clock; use UTC parsing and UTC date setters so regenerating the assets is deterministic.

Useful? React with 👍 / 👎.

@guhcostan
guhcostan merged commit 725f5e7 into main Oct 2, 2026
8 checks passed
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.

2 participants