Repository navigation
README: load the docs badge through shields.io - #425
Merged
Merged
Conversation
GitHub's image proxy gets 429 Too Many Requests from Read the Docs, so the docs badge shows as a broken image on GitHub only. Read the Docs also marks the badge no-store, so the proxy can't cache it. Use the shields.io Read the Docs badge, like the README's other badges. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
|
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.
The "Documentation Status" badge still shows as a broken image on GitHub after #421, but it works everywhere else.
Cause: GitHub loads README images through its camo proxy. For the Read the Docs badge URL, camo returns
502 Invalid upstream response (429). Read the Docs is rate-limiting the proxy, and this failed 5 times out of 5. Fetched directly, the same URL returns the SVG. Read the Docs also sendscache-control: no-storeon the badge, so camo can't cache it and has to fetch it again for every view.Fix: use the shields.io Read the Docs badge,
https://img.shields.io/readthedocs/nunavut/latest.svg, which matches the README's other shields.io badges. The badge's link target (nunavut.readthedocs.io) is unchanged.Checked: I rendered this branch's README through the GitHub API and fetched the badge's camo URL three times. Each fetch returned
200 image/svg+xml, showing "docs: passing".🤖 Generated with Claude Code