docs: package README logos use a blob URL that does not render outside GitHub
維護者通常 1 天內回覆
還沒有人認領這個 Issue。
評估
- 難度
- 2/5
- 預估耗時
- 1-3 小時
- 新手友好度
- 84/100
- Issue 類型
- 文件
- 描述清晰度
- 描述清楚
- 活躍度
- 活躍
- 技術堆疊
- typescript
研究方向
從 modules/ecs/README.md#L4 中的範例開始,接著在 13 個 package README 中搜尋 logo URL。將每個 GitHub blob URL 替換為圖片 URL,例如 issue 中的 raw.githubusercontent.com URL。完成標準是:所有 package README 中的 logo 在 GitHub 之外都能顯示為圖片。
由索引模型根據 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
環境準備
- 沒有 Dockerfile 或 Docker Compose 檔案
- 有 Pull Request 範本
- 閱讀貢獻指南
從這裡開始
- 先讀完整個 Issue,再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫,在一個分支上完成修改。
- 送出 Pull Request,並在描述裡引用這個 Issue 編號。
NanoForge-dev/Engine 的其他 Issue
-
dependencies enhancement good first issue
難度 2/5 1-3 小時 新手友好度 78/100
NanoForge-dev/Engine#513 ·
維護者通常 1 天內回覆
-
bug chore tests
難度 2/5 1-3 小時 新手友好度 77/100
NanoForge-dev/Engine#511 ·
維護者通常 1 天內回覆
-
docs(network): TSDoc says ICE_SERVERS defaults to an empty list, the code uses public STUN servers未關閉documentation good first issue modules:network
難度 1/5 1 小時以內 新手友好度 88/100
NanoForge-dev/Engine#509 ·
維護者通常 1 天內回覆
-
documentation modules:ecs packages:asset packages:core
難度 2/5 1-3 小時 新手友好度 82/100
NanoForge-dev/Engine#508 ·
維護者通常 1 天內回覆
-
bug good first issue modules:music modules:sound
難度 2/5 1-3 小時 新手友好度 78/100
NanoForge-dev/Engine#505 ·
維護者通常 1 天內回覆
查看 NanoForge-dev/Engine 的全部 Issue
相似的 Issue
-
Mend: dependency security vulnerability
難度 1/5 1-3 小時 新手友好度 65/100
fdm-monster/fdm-monster#5563 ·
維護者通常 1 天內回覆
-
難度 2/5 1-3 小時 新手友好度 72/100
be-BOP-io-SA/be-BOP#2849 ·
-
難度 2/5 1-3 小時 新手友好度 79/100
維護者通常 1 天內回覆
-
1️⃣ phase/under-investigation flaky/confirmed flaky/needs-decision type/bug
難度 2/5 1-3 小時 新手友好度 65/100
growilabs/growi#12246 · 3 則留言 ·
維護者通常 1 天內回覆
-
🐛 The Rulekeeper - An index run that gives up on the lock ends Succeeded可能已有人在做 @github-actions 今天認領。 未關閉
難度 2/5 1-3 小時 新手友好度 72/100
SSWConsulting/SSW.Rules#2809 · 1 則留言 ·
維護者通常 1 天內回覆