Repository navigation
docs: draw a new social preview from a real run - #12
Merged
Merged
Conversation
…om style The card now shows the name, the language and the repo description on a gritty paper panel, beside a tilted ink panel with the first five cases of the reorder run. The three fonts it uses are in docs/fonts with their OFL licence, so the card draws the same on any machine.
github-actions
Bot
added
the
documentation
awss1i
changed the title
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
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.
What This Changes
The image GitHub shows in links to this repo was a dark card with the icon, the name and the install line. This replaces it with a card in a different, cleaner style. A gritty paper panel on the left has the name, the language and the repo description, and a tilted ink panel on the right has the first five cases of a real run of
assay ./reorder, with failures in orange.docs/social.pydraws the card from that run in the benchmark, the same waydocs/hero.pydrawsrun.svg. The three fonts it uses (Dela Gothic One, Shippori Mincho B1 and JetBrains Mono) are indocs/fontswith their OFL licence, so the card draws the same on any machine. The script saves the PNG at 1280x640, which keeps it at about 835 KB, under GitHub's 1 MB limit for a social preview.Kind
Tests
python docs/social.py docs/social-preview.pngdraws the committed image. Nothing outsidedocs/changes.Benchmarks
Not needed. The change doesn't touch a rule or any file in
bench/.AI use