fix(readme): restore banner with packaged asset#4
Merged
Conversation
The GitHub raw-hosted image URL currently renders as a broken image in the README view. This switches the banner back to a repo-relative asset and includes that asset in the npm package files so both GitHub and the npm package page can resolve it without depending on GitHub raw URL serving. Constraint: Keep the fix narrowly scoped to the README banner path and package file whitelist Rejected: Keep using a raw.githubusercontent.com URL | current raw URLs return 404 in practice for this repo and break the rendered README Confidence: high Scope-risk: narrow Reversibility: clean Directive: Keep README images on packaged relative paths or another verified stable host; do not assume raw GitHub URLs will render reliably Tested: npm pack --dry-run --json includes assets/readme-banner.svg and README references the packaged relative asset Not-tested: Live npm/GitHub renderer refresh after merge; behavior is inferred from the packaged relative path and current broken raw URL evidence
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.
Why
The README banner was rendering as a broken image because the GitHub raw-hosted URL in the README was returning 404.
What changed
assets/readme-banner.svgto the npm package file whitelist so the npm package page can resolve it too.Verification
npm pack --dry-run --jsonincludesassets/readme-banner.svgRisk