docs: the README front page shows the tool and counts it right - #20
Merged
Merged
Conversation
The front page had to do two jobs it was not doing: make a visitor want the
download, and be true. It is now ordered badges, one paragraph, the star ask,
what it can do, two moving pictures, then the table of contents.
Measured before writing, because the README is the shop window:
* All five badge endpoints answer, with real values - CI passing, release
v0.2.0, downloads 82, GPLv3, platform. The green Download badge and the Go
badge came off, and the three platform badges lost their links because a
platform is a fact and not a place to go.
* Anchors come from GitHub's own renderer, read back from this repository
rather than worked out from the heading text. That found a trap worth
keeping: an emoji carrying a variation selector leaves the selector behind
in the slug, so "Commands" answers to an anchor beginning with an
invisible U+FE0F while "Formats it generates" answers to a plain hyphen.
A link written the way it looks on screen would be dead and would look
right. Nineteen of the twenty entries are confirmed against that render.
Four sentences said things that stopped being true. The tool registers twenty
one formats, the intro claimed twenty and the feature table said twenty. TIFF
shipped and the question about what comes next still listed it. The manifest
sample quoted version 0.1.0. And the first sentence ended with two full stops.
The feature table is gone rather than duplicated: the same eight rows read
better as a list, and four more went in that the table never carried - the
boundary set, ten thousand files at once, an archive with real contents, and
per format settings. Every one of them is something the seven browser based
generators measured in August do not do.
window.png stays in the tree. The README no longer shows it, but the website
does, and a guard compares the two copies byte for byte.
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.
The front page had two jobs it was not doing: make a visitor want the download,
and be true. The order is now badges, one paragraph, the star ask, what it can
do, two moving pictures, then the table of contents.
Measured before writing
Badges. All five endpoints answer, with the values a visitor will see: CI
passing, release v0.2.0, downloads 82, GPLv3, platform. The green Download badge
and the Go badge came off. The three platform badges lost their links, because a
platform is a fact rather than a place to go.
Anchors. Read back from GitHub's own renderer rather than worked out from
the heading text, first on
mainand then on this branch. That found a trapworth writing down: an emoji carrying a variation selector leaves the selector
behind in the slug, so
Commandsanswers to an anchor beginning with aninvisible U+FE0F while
Formats it generatesanswers to a plain hyphen. A linkwritten the way it looks on screen would be dead and would look right. All
twenty entries are confirmed against the render of this branch.
Four sentences that had stopped being true
PDF, PNG, JPG, ZIP, DOCX, XLSX and fourteen more20 real formats7z,tiff,webp,mp3,mp4"version": "0.1.0"0.2.0The first sentence of the file also ended with two full stops.
What it can do
The feature table is gone rather than duplicated. The same eight rows read
better as a list, and four more went in that the table never carried: the
boundary set in one command, ten thousand files at once, an archive with real
contents, and per format settings. Each of those is something none of the seven
browser based generators surveyed in August offers.
Two notes for the reviewer
.github/window.pngstays in the tree. The README no longer shows it, but thewebsite does, and
site_test.gocompares the two copies byte for byte.The paragraph says the manifest is "the part other generators leave to you".
That is a claim about the world outside this repository, it rests on the survey
of seven competing tools done in August, and nothing in CI can hold it true.
Checks
TestProseInTheRepositoryUsesFlatHyphensAndNoSemicolons,TestTextInTheRepositoryIsAsciiOnly,TestNoTrackedFileCarriesPrivateContent,TestNoCommitMessageCarriesPrivateContentandTestNoBranchOrTagNameCarriesPrivateContentare green. The private content scanreads untracked files too, so both new GIFs went through it. The full suite was
not run locally - CI covers it.
🤖 Generated with Claude Code