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

Abierto Apto para principiantes
#466 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
84/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
typescript

Línea de trabajo

Empieza con el ejemplo de modules/ecs/README.md#L4 y luego busca la URL del logo en los 13 README de los paquetes. Sustituye cada URL de GitHub blob por una URL de imagen, como la URL de raw.githubusercontent.com del issue. La tarea estará completa cuando todos los logos de los README de los paquetes se muestren como imágenes fuera de GitHub.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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

Lenguaje dominante
TypeScript
Estrellas
7
Forks
2
Merge medio
1 d 17 h
PR fusionados (30 d)
17

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de NanoForge-dev/Engine

Todos los issues de NanoForge-dev/Engine

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.