Skip to content

docs: recapture README screenshots against the Macs-era UI - #96

Merged
MegaManSec merged 4 commits into
mainfrom
docs/readme-screenshot-refresh
Aug 6, 2026
Merged

docs: recapture README screenshots against the Macs-era UI#96
MegaManSec merged 4 commits into
mainfrom
docs/readme-screenshot-refresh

Conversation

@MegaManSec

@MegaManSec MegaManSec commented Aug 6, 2026

Copy link
Copy Markdown
Owner

Every annotated README screenshot predated the July/August UI work (last captured June 8 in #52). Recaptured against the current app:

annotate-screenshots.sh: coordinates and legends reworked, device-tabmacs-tab, missing raws skip instead of aborting, the Other-tab stitch is scripted, and the menu legend's % is escaped from ImageMagick. README captions updated to match.

Still stale: the four Pairing screenshots (old tab strip; the enter dialog predates the ghost-dash preview from #78/#85). Drop recaptures into docs/assets/raw/ (dialogs straight into docs/assets/) and re-run the script.

Every annotated screenshot predated the July/August UI work: the Device
tab rename to Macs (with Sync and Add by Address), battery levels in the
menu and peripheral rows, the uniform action pills, the keyboard-shortcut
recorders, and the display-connect list. Recapture all of them, add the
previously unillustrated Add a Mac by Address sheet, and update the
annotation script's coordinates and legends to match (device-tab becomes
macs-tab; sections without a raw capture are now skipped instead of
aborting). README captions follow: battery levels in the hero and
Peripheral tab, the new sheet figure in Setup, and an Other-tab caption
that matches the scrolled capture.

The four Pairing screenshots are still the old captures.
The Other tab outgrew the window, so one scrolled capture hid either the
top or the bottom. Stitch three scrolled captures into a single
full-height raw — slices cut on flat background between sections, aligned
by crop offset, overlay scrollbar painted out — and re-badge all six
affordances. Revert peripheral-type-picker.png to the previous capture:
menu-item icons only render on macOS 26, and the recapture came from a
Sequoia Mac, so its picker menu was text-only.
…w itself

- menu.png previously showed every row greyed out (peer unreachable) —
  the state Troubleshooting teaches as "can't switch" — under a caption
  inviting clicks. Recaptured with the other Mac online; legend background
  re-matched to the new capture's material.
- The Other tab's badge 5 pointed at the marked display's trash button
  while its legend line describes the row; aim it at the row title.
- docs/assets/raw/ is local input to annotate-screenshots.sh — gitignore
  it so stray git add -A can't commit raw captures.
…ge (#95) (#97)

* docs: pair the Macs before connecting them — reorder Setup steps 3 and 4 (#95)

An unpaired Mac refuses incoming connections outright, so Add by Address
can only ever time out until both sides hold the pairing key — yet Setup
walked through the Macs tab (including Add by Address) before the Pairing
tab. Pairing needs no connectivity, so pairing-first is safe in every
flow. Say so explicitly in both sections, and document the one endpoint
staleness case the INTRODUCE exchange can't heal: both Macs changing IP
at once on a Bonjour-blocked network.

* fix: name the likely causes when Add by Address can't reach the peer (#95)

An unpaired peer cancels the connection before the handshake, which the
dialing side can't tell apart from a firewall drop or a dead host — the
sheet just said the other Mac "didn't respond", steering users at the
network when the actual fix is usually pairing first. Give the four
unreachable-shaped failures one message naming all three causes; auth
failures keep their precise wording.

* fix: cover every unreachable-shaped Add by Address failure (#95)

- A peer reset can land while the handshake nonce send is in flight
  (handshakeFailed(.sendFailed)), and a non-Magic-Switch service
  answering on the port yields framingFailed/frameTooLarge — the same
  unreachable shape, previously falling through to the generic
  secure-connection message. Fold all three into the lumped case.
- Point at Settings → Pairing in that message, matching .notPaired.
- Dialing before this Mac's own listener is bound reported the local
  condition as a peer-shaped connection failure; fail early with a
  dedicated .listenerNotReady message instead.
- README: an unpaired Mac refuses the connection immediately, so say
  the add fails rather than times out.
@MegaManSec
MegaManSec merged commit e4376ee into main Aug 6, 2026
@MegaManSec
MegaManSec deleted the docs/readme-screenshot-refresh branch August 6, 2026 23:17
@github-actions

github-actions Bot commented Aug 7, 2026

Copy link
Copy Markdown

🎉 This PR is included in version 2.25.3 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

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

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant