The hero didn't show the thing, and six pages hadn't heard#11
Merged
Conversation
The front door changed and six pages didn't follow. Two of them contradicted themselves on the same screen: npm and PyPI shipped package descriptions saying 'walks your GitHub contribution year' above READMEs still saying 'a personality layer any CLI can embed'. I wrote the first half yesterday and left the second. usage/README opened with 'What is awan *for*?' and answered with the old pitch. It's the embed examples — it says that now, and points at the profile for what most people came for. crates/awan/README keeps 'personality layer any CLI can embed'. That crate *is* the embed API; it's the one page where the old sentence was never wrong. docs/PROFILE.md was orphaned — nothing linked it, and it still described the core as 'the personality-layer CLI'. It's design notes, so it now says so at the top, points users at profile/ and the editor instead, and profile/ links back to it for anyone changing the thing. And one real bug: profile/README still told readers to run gifsicle with --lossy=80. We dropped that flag because it ghosted the 14px contribution squares for a 6% saving. Anyone following the docs was damaging their own GIF.
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 headline promised something the picture didn't have
banner.gifis the project flavour — this repo's stars and version. It hasnever contained the contribution wall. Its alt text said "awan walking a
contribution year", which I wrote yesterday, and which was simply untrue.
The GIF that does walk a year was twenty lines further down. They're swapped:
profile-sample.gifis the hero, andbanner.gifreturns to the footer wherebeing a live self-portrait is the point rather than a duplicate. That also fixes
the thing that prompted this — two 700px GIFs of the same character within one
screen of each other.
And the docs hadn't caught up
packages/npm/READMEpackage.json, same screenpackages/pypi/READMEusage/READMEdocs/PROFILE.mdcrates/awan/READMEnpm and PyPI contradicting themselves is mine: I changed the package
descriptions yesterday and left the READMEs.
One real bug
profile/READMEstill told readers to rungifsicle --lossy=80. We droppedthat flag because it ghosted the 14px contribution squares to save 6%. Anyone
following the docs was quietly damaging their own GIF.
Every relative link resolves and every external link is live — checked, and the
two that looked broken were my checker being naive about code samples.