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

Aperta Adatta ai principianti
  • Qualcosa non va?
#466 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
84/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
typescript
Ambito
documentation

Direzione di ricerca

Inizia con l’esempio in modules/ecs/README.md#L4, poi cerca l’URL del logo nei 13 README dei pacchetti. Sostituisci ogni URL GitHub blob con un URL immagine, come l’URL raw.githubusercontent.com nell’issue. Il lavoro è completato quando tutti i loghi nei README dei pacchetti vengono visualizzati come immagini al di fuori di GitHub.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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).

Lingua principale
TypeScript
Stelle
7
Fork
2
Merge medio
1g 17h
PR unite (30g)
17

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di NanoForge-dev/Engine

Tutte le issue di NanoForge-dev/Engine

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.