docs: package README logos use a blob URL that does not render outside GitHub

未關閉 適合新手
#466 0 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視

維護者通常 1 天內回覆

還沒有人認領這個 Issue。

評估

難度
2/5
預估耗時
1-3 小時
新手友好度
84/100
Issue 類型
文件
描述清晰度
描述清楚
活躍度
活躍
技術堆疊
typescript
領域
documentation

研究方向

從 modules/ecs/README.md#L4 中的範例開始,接著在 13 個 package README 中搜尋 logo URL。將每個 GitHub blob URL 替換為圖片 URL,例如 issue 中的 raw.githubusercontent.com URL。完成標準是:所有 package README 中的 logo 在 GitHub 之外都能顯示為圖片。

由索引模型根據 Issue 內容生成。

描述

documentation good first issue
What is the type of issue?

Documentation is incorrect

What is the issue?

The package READMEs show the NanoForge logo with <img src="https://github.com/NanoForge-dev/Engine/blob/main/.github/logo.png">. A blob/ URL returns GitHub's HTML page for the file, not the image (curl -sI → content-type: text/html), so the logo only works on github.com, which rewrites it. These READMEs are now published as the package pages of the API reference on docs.nanoforge.eu (branch feat/docs-navigation, TypeDoc with the README as each package's index), where the image will be broken.

Expected: an image URL, e.g. https://raw.githubusercontent.com/NanoForge-dev/Engine/main/.github/logo.png (or ?raw=true).

All 13 package READMEs, for example https://github.com/NanoForge-dev/Engine/blob/0470c096970747dbf5774420f0ca1b4d47f2927f/modules/ecs/README.md#L4

Where did you find it?

https://github.com/NanoForge-dev/Engine/blob/0470c096970747dbf5774420f0ca1b4d47f2927f/modules/ecs/README.md#L4 — found while reviewing the docs navigation rework (branch feat/docs-navigation).

主要語言
TypeScript
星號
7
分支
2
平均合併
1 天 17 小時
30 天內合併 PR
17

環境準備

從這裡開始

  1. 先讀完整個 Issue,再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫,在一個分支上完成修改。
  4. 送出 Pull Request,並在描述裡引用這個 Issue 編號。

NanoForge-dev/Engine 的其他 Issue

查看 NanoForge-dev/Engine 的全部 Issue

相似的 Issue

更多 TypeScript Issue

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。