Skip to content

docs: accuracy pass over README and docs for the 0.5.2-0.6.1 changes - #29

Merged
bthall merged 2 commits into
mainfrom
docs/post-0.6.1-accuracy-pass
Jul 23, 2026
Merged

docs: accuracy pass over README and docs for the 0.5.2-0.6.1 changes#29
bthall merged 2 commits into
mainfrom
docs/post-0.6.1-accuracy-pass

Conversation

@bthall

@bthall bthall commented Jul 23, 2026

Copy link
Copy Markdown
Owner

Summary

One review pass over the README, docs, and screenshots against everything that landed today (v0.5.2 through v0.6.1).

Docs

  • The command table still called bare mox an "interactive picker"; the editor section still said "Ctrl-E in the picker". Both now say hub.
  • The editor's a key said the wizard result "lands as a draft" with no mention that save + start now opens the diff preview and starts the session detached after the save.
  • The hub section didn't explain that import/edit hand off and return to a fresh hub; the glyph legend now sits in its own paragraph.
  • mox add's described choices now match the wizard's real labels (save to config / save + start now).
  • The import route in commands.md and the import recipe now mention the hub's i shortcut; the README hub blurb includes import.

Screenshots

All three screenshots showed the pre-0.6.1 UI: the hub footer lacked i import, and unmanaged sessions had the old yellow instead of . They're regenerated and now reproducible:

  • A new env-guarded generator (TestGenerateScreenshots, skipped in normal runs) renders the real hub/list/editor views with staged demo data as ANSI frames. No live tmux, no real session names.
  • make screenshots runs the generator and renders the frames to PNG with charm's freeze (DejaVu Sans Mono; freeze's default font draws two cells wide and breaks panel alignment).
  • The retired numbered picker's screenshot is deleted; nothing referenced it.

Supporting change: useColor honors CLICOLOR_FORCE=1 (de facto standard, NO_COLOR still wins) so the generator can color mox list's raw-ANSI output into a file. Also makes mox list | less -R colorable. Covered in TestTUIColorProfile; changelog entry under Unreleased.

Verified clean: no leftover "picker" references, no em dashes in the README, make test and golangci-lint v2 pass.

bthall added 2 commits July 23, 2026 10:43
- bare mox is the session hub, not the retired numbered picker; fix the
  command table and the editor section's "Ctrl-E in the picker"
- editor wizard's "save + start now" now saves through the diff preview
  and starts the session detached; say so on the a key
- hub: document the import/edit handoff loop, split the glyph legend
  into its own paragraph, and match the wizard's real choice labels
- import: mention the hub's i shortcut in commands and recipes
- README: hub blurb includes import
All three README screenshots showed the pre-0.6.1 UI: the hub footer
lacked i import, and unmanaged sessions carried the old yellow dot
instead of the diamond. Regenerated from the real TUI models with
staged demo data via a new env-guarded generator
(TestGenerateScreenshots) rendered through charm's freeze; `make
screenshots` reruns the whole pipeline. The retired numbered picker's
screenshot is removed (nothing referenced it).

To color mox list's frame into a file, useColor now honors
CLICOLOR_FORCE=1 (the de facto standard; NO_COLOR still wins), which
also makes `mox list | less -R` colorable.
@bthall
bthall merged commit 27a6e31 into main Jul 23, 2026
10 checks passed
@bthall
bthall deleted the docs/post-0.6.1-accuracy-pass branch July 23, 2026 15:27
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