Trim the README and refresh the quota screenshot - #63
Merged
Merged
Conversation
The README explained the menu bar, restated the product framing three times, and illustrated quota with a screenshot of the old single-bar row that no longer exists. Work and goals now sit behind a disclosure so the front page leads with the one thing most people install this for. Regenerating the screenshot surfaced a real layout bug: Cursor labels its windows 'API' and 'Auto' rather than '5h' and '7d', and the 18pt label column wrapped 'Auto' onto two lines. The column width moves to QuotaCaption with a test that measures every shipped label against it. The snapshot harness now mocks providers that all have readings, so the screenshot shows the product working rather than a no-data placeholder.
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.
README
The front page restated the product framing three times (tagline, "What it is", "Three things people actually use it for") and spent its first screens explaining why a menu bar is useful. It now leads with the concrete problem — rolling quota windows — and the picture that answers it.
Work timer and goals move into a
<details>block. They are off by default, so they no longer compete with quota for the top of the page. Both READMEs stay at 95 lines but carry less repetition and a much shorter path toInstall.Screenshot
use-quota.pngstill showed the old single-bar row, which the redesign replaced. Regenerated from the live views viascripts/screenshots.sh.Layout bug found while regenerating
Cursor labels its windows API / Auto, not 5h / 7d. The 18pt label column wrapped "Auto" onto two lines and broke the row's alignment — visible in the first regenerated frame. The width moves to
QuotaCaption.windowLabelWidth(26pt), andtestWindowLabelColumnFitsWordLabelsmeasures every shipped label against it so a future label that does not fit fails the build rather than the screenshot.The snapshot harness previously mocked a provider with
weekPercent: nil, which after the last PR correctly rendersno data · check sign-in. Marketing screenshots should show the product working, so the mocks now all carry readings; the placeholder state is covered by tests instead.Verification
swift buildpasses,python3 Tests/quota/test_quota.py35/35, all README links and image paths resolve. Screenshots visually checked in light and dark.swift teststill cannot run locally (CommandLineTools ships no XCTest) — CI must confirm.