Repository navigation
docs: use raw.githubusercontent URL for package README logos - #473
Merged
MartinFillon merged 1 commit intoNov 11, 2026
Merged
Conversation
cdytotoro-ctrl
requested review from
Exeloo,
MartinFillon and
Tchips46
as code owners
November 11, 2026 00:59
Contributor
|
Hi, thank you for your pull request, this is a nice change that I hope will convince you to continue help us work on Nanoforge |
MartinFillon
approved these changes
Nov 11, 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 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.
Summary
Package READMEs linked the NanoForge logo with a GitHub
blob/URL:A
blob/URL responds withtext/html(GitHub's file page), not an image, so the logo only renders on github.com, which rewrites the link. Everywhere else - including the package pages of the API reference generated by TypeDoc - the image is broken.This replaces the
srcwith the raw asset URL in all 16 READMEs that used it:Scope:
typedoc(packages/*,modules/*) - the files named in docs: package README logos use a blob URL that does not render outside GitHub #466;utils/*package READMEs, which carry the identical brokensrcand are published on npm, so they are fixed for consistency.Only the
<img src>value changes; one line per file. Anchors,width/altattributes, badges and theblob/links used for navigation (e.g.CONTRIBUTING.md) are untouched, since blob URLs are correct for links.Verification
grep -r 'Engine/blob/main/.github/logo.png' --include=*.mdreturns no<img src>hits.curl -sL <raw url>->200,content-type: image/png, 20534 bytes, sha256 identical to.github/logo.png.curl -sL <blob url>->content-type: text/html, reproducing the reported defect.src, same encoding/EOL/line count.No code, lockfile or config changes; no test suite is affected by a Markdown-only change.