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

オープン 初心者向け
#466 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
84/100
issue の種類
ドキュメント
明瞭さ
明確に書かれている
活発さ
活発
技術スタック
typescript
領域
documentation

調査の方向性

modules/ecs/README.md#L4 の例から始め、次に 13 個のパッケージ README でロゴの URL を検索します。各 GitHub blob URL を、issue にある raw.githubusercontent.com の URL のような画像 URL に置き換えます。GitHub 以外で、すべてのパッケージ README のロゴが画像として表示されれば完了です。

索引モデルが 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時間
マージ済み PR(30日)
17

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

NanoForge-dev/Engine のほかの issue

NanoForge-dev/Engine の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。