Skip to content

docs: use raw.githubusercontent URL for package README logos - #473

Merged
MartinFillon merged 1 commit into
NanoForge-dev:mainfrom
cdytotoro-ctrl:oss/issue-466-20261111005904
Nov 11, 2026
Merged

MartinFillon merged 1 commit into
NanoForge-dev:mainfrom
cdytotoro-ctrl:oss/issue-466-20261111005904

Conversation

@cdytotoro-ctrl

Copy link
Copy Markdown
Contributor

Summary

Package READMEs linked the NanoForge logo with a GitHub blob/ URL:

https://github.com/NanoForge-dev/Engine/blob/main/.github/logo.png

A blob/ URL responds with text/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 src with the raw asset URL in all 16 READMEs that used it:

https://raw.githubusercontent.com/NanoForge-dev/Engine/main/.github/logo.png

Scope:

Only the <img src> value changes; one line per file. Anchors, width/alt attributes, badges and the blob/ 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=*.md returns 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.
  • Byte comparison against pre-edit snapshots: no change outside the substituted src, same encoding/EOL/line count.

No code, lockfile or config changes; no test suite is affected by a Markdown-only change.

@github-actions github-actions Bot added packages:common Related to Common library packages:core Related to Core library utils:prettier-config Related to Prettier config utils:eslint-config Related to ESLint config modules:ecs Related to ECS library modules:editor Related to Editor library modules:graphics-2d Related to Graphics2D library modules:input Related to Input library modules:music Related to Music library modules:network Related to Network library modules:sound Related to Sound library packages:asset Related to AssetManager library packages:env Related to Env library modules:scene Related to Scene library modules:graphics-3d Related to Graphics3D library labels Nov 11, 2026
@MartinFillon

Copy link
Copy Markdown
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
MartinFillon merged commit be72076 into NanoForge-dev:main Nov 11, 2026
7 of 8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

modules:ecs Related to ECS library modules:editor Related to Editor library modules:graphics-2d Related to Graphics2D library modules:graphics-3d Related to Graphics3D library modules:input Related to Input library modules:music Related to Music library modules:network Related to Network library modules:scene Related to Scene library modules:sound Related to Sound library packages:asset Related to AssetManager library packages:common Related to Common library packages:core Related to Core library packages:env Related to Env library utils:eslint-config Related to ESLint config utils:prettier-config Related to Prettier config

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants