docs: put the pgbot mark in the README header - #106
Merged
Merged
Conversation
The mark existed only as the pgrundev org avatar, so the README opened on a bare <h1> and nothing in the repo carried the brand. Commit it instead of hotlinking avatars.githubusercontent.com: that URL is bound to the org avatar, so changing the avatar would silently change the README, and its ?s= sizes are too small for a HiDPI display. The uploaded avatar is RGB with no alpha — the rounded corners on GitHub are GitHub's own crop, not part of the file — so dropped into a README it rendered as a hard black square on the light theme. Masked a rounded rect into the alpha channel instead. The frame stays: the face is white and disappears against the light theme's white background without it. Rendered at 82px from a 164px source, exactly 2x. Also adds docs/img/social-preview.png (1280x640) for the repo's social preview card, which is currently unset — shared links unfurl as a generic GitHub box. That image has to be uploaded through repo Settings; it cannot be set from a commit, so it is versioned here and applied by hand.
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 mark lived only as the
pgrundevorg avatar, so the README opened on a bare<h1>and nothing in the repo carried it.Why the image is committed rather than hotlinked
avatars.githubusercontent.com/u/300654937is bound to the org avatar — changing the avatar would silently change the README — and its?s=sizes are too small for a HiDPI display. A repo file is versioned with the code.Why the frame stays, with alpha added
The uploaded avatar is RGB with no transparency: the rounded corners you see on GitHub are GitHub's own crop, not part of the file. Dropped straight into a README it rendered as a hard black square on the light theme. I masked a rounded rect into the alpha channel.
Cutting out just the circle was the first thing I tried, and it fails — the face is white and vanishes against the light theme's white background. The dark frame is what makes the mark legible there; on the dark theme it merges and the circle floats.
Rendered at 82px from a 164px source, exactly 2x.
Social preview
Also adds
docs/img/social-preview.png(1280×640). The repo's social preview is currently unset, so shared links unfurl as a generic GitHub box. This one cannot be applied by merging — it has to be uploaded through Settings → Social preview. It is committed so the source is versioned.Known limitation
The source avatar is only 164×164 — GitHub returns 164 even for
?s=460, so that is the ceiling of what was uploaded. It is fine at 82px in the README, but the org profile page renders avatars much larger and will look soft. Worth re-uploading both from a higher-resolution original when one is available.