Uh oh!
There was an error while loading. Please reload this page.
fix(docs): host README screenshots in the repository - #71
Merged
Conversation
The three feature screenshots were hot-linked to the marketing site's media library, which now returns 404 for all three, so the README shows broken images on both the GitHub project page and PyPI. GitHub also wraps README images in an anchor to its image proxy, so each broken image renders as a clickable link to a "Not Found" page. Commit the recovered originals under ASCII-only names and reference them by absolute raw-content URL. Two of the original filenames contained a narrow no-break space (U+202F) from macOS screenshot naming, invisible in the source; the new names avoid it. Repository-relative paths would fix the GitHub page but not PyPI, which cannot resolve them.
Coverage Report •
|
aarthy-dk
approved these changes
Aug 26, 2026
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 freeto join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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 three feature screenshots in the README were hot-linked to
datakitchen.io's WordPress media library. All three now return 404 — the
media was removed or renamed on the website side — so the README shows
broken images on both the GitHub project page and the PyPI project page,
which publishes this README as the package long description.
GitHub also wraps README images in an anchor to its image proxy, so each
broken image renders as blue underlined alt text that leads to a
"Not Found" page when clicked. Readers see three broken images and three
dead links.
This commits the recovered originals to
docs/assets/images/readme/andreferences them by absolute raw-content URL. Repository-relative paths
would fix the GitHub page but not PyPI, which cannot resolve them.
Two of the original filenames contained a narrow no-break space (U+202F)
from macOS screenshot naming — invisible in the source, and a hazard for
any restore under the same names. The new names are ASCII-only.
Also fixes the
DatKitchentypo in the first image's alt text.