docs: accuracy pass over README and docs for the 0.5.2-0.6.1 changes - #29
Merged
Conversation
- 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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
One review pass over the README, docs, and screenshots against everything that landed today (v0.5.2 through v0.6.1).
Docs
moxan "interactive picker"; the editor section still said "Ctrl-Ein the picker". Both now say hub.akey 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.mox add's described choices now match the wizard's real labels (save to config / save + start now).ishortcut; 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: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 screenshotsruns the generator and renders the frames to PNG with charm'sfreeze(DejaVu Sans Mono; freeze's default font draws◆two cells wide and breaks panel alignment).Supporting change:
useColorhonorsCLICOLOR_FORCE=1(de facto standard,NO_COLORstill wins) so the generator can colormox list's raw-ANSI output into a file. Also makesmox list | less -Rcolorable. Covered inTestTUIColorProfile; changelog entry under Unreleased.Verified clean: no leftover "picker" references, no em dashes in the README,
make testand golangci-lint v2 pass.