docs: refresh the README and the GUI section for V3 - #124
Merged
Conversation
The release went out with screenshots of the interface it replaced, which is the one thing a release README must not do. - All four screenshots regenerated. They are rendered from the page's own mock engine, so the captions describe the interface instead of asserting throughput figures that were never measured — the `demo` chip visible in the corner is the page saying the same thing. The one real measurement in the README (195.7 MB/s, documented in ENGINEERING_NOTES.md) stands on its own and no longer leans on a screenshot. - A new cold-open capture, since that is the first thing anyone now sees. - "What V2 is" becomes "What V3 is": a before/after table of what changed in the interface, the keyboard shortcuts, and the motion decision stated plainly with a pointer to open an issue if a preference is wanted. - The provider comparison keeps its own heading rather than standing in for the release summary. - ARCHITECTURE.md described "the four cards" and rows without a provider; both are now what the code actually renders. - The mock reported "v2.0 · preview", so every preview render and every screenshot taken from it under-reported the version. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
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
1 participant
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.
V3 shipped with screenshots of the interface it replaced. This fixes that.
mock engine, so the captions describe the interface rather than asserting
throughput figures that were never measured — the
demochip visible in thecorner is the page saying the same thing. The one real measurement in the
README (195.7 MB/s, method in
docs/ENGINEERING_NOTES.md) stands on its ownand no longer leans on a screenshot.
changed, the keyboard shortcuts, and the motion decision stated plainly with a
pointer to open an issue if a preference is wanted. The provider comparison
keeps its own heading instead of standing in for the release summary.
docs/ARCHITECTURE.mddescribed "the four cards" and rows without aprovider; both now match what the code renders.
v2.0 · preview, so every preview render — and everyscreenshot taken from one — under-reported the version.
Note: the
v3.0tag predates this commit, so the tagged tree still has the mocksaying
v2.0 · preview. That only affects the preview path, openingweb/index.htmldirectly without Python; the real app readsVERSIONfrommoon_download.py, which isv3.0. Not worth moving a published tag over.🤖 Generated with Claude Code