docs: use absolute GitHub URLs for README images#235
Merged
Conversation
Replaces relative paths (./images/*, ./examples) with absolute URLs to raw.githubusercontent.com and github.com respectively. This hardens the README against any npm CDN/rewrite oddities so the GIF, screenshot, and examples link work uniformly on github.com, npmjs.com, and any other markdown renderer. No code/dist changes — README only. Co-Authored-By: Claude Opus 4.7 (1M context) <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
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.
Summary
Replaces relative paths in README.md with absolute URLs so they render reliably across github.com, npmjs.com, and any other markdown viewer that doesn't auto-rewrite relative paths.
Changes
./images/twd-skill.gifhttps://raw.githubusercontent.com/BRIKEV/twd/main/images/twd-skill.gif./images/twd_side_bar_success.pnghttps://raw.githubusercontent.com/BRIKEV/twd/main/images/twd_side_bar_success.png[Examples Directory](./examples)[Examples Directory](https://github.com/BRIKEV/twd/tree/main/examples)Why
The
images/folder is not in the npm tarball ("files": ["dist", "README.md", "LICENSE"]excludes it). The previous relative paths only rendered correctly when npmjs.com auto-rewrote them via therepositoryfield — which works most of the time but had a propagation delay around the 1.7.3 release that briefly showed broken images. Absolute URLs eliminate that dependency.The contributor avatars in this README already use absolute URLs to
avatars.githubusercontent.com— this brings the GIF and screenshot in line with that pattern.Test plan
🤖 Generated with Claude Code