README and catalog/README give incomplete filter and guide lists

Abierto Apto para principiantes
  • ¿Algo no está bien?
#270 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
78/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
javascript
Área
documentation

Línea de trabajo

Lee las secciones indicadas en README.md y catalog/README.md y luego consulta en CONTRIBUTING.md el flujo de trabajo de npm run new-entry y la tabla de guías de README. Actualiza las rutas del plan interno de actualización del sitio en docs/internal/superpowers/plans/ para que apunten a docs/internal/superpowers/specs/. Se habrá terminado cuando se corrijan los cuatro elementos de la lista de verificación; el issue menciona npm test y npm run check como comandos de verificación.

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

Descripción

documentation good first issue priority: low

Summary

The README's description of site filters leaves out several that exist, and the catalog index still steers contributors to copy TEMPLATE.md instead of using the scaffold.

Where

  • README.md:153-155
  • catalog/README.md:3, :18
  • docs/internal/superpowers/plans/2026-10-23-site-refresh.md:11, :465

Details

  • README:153-155 lists category, commercial use, attribution, review status and 2D camera view; it omits the Licence, Format and Engine filters (license-family, format-group, engine in index.html), the sort control and the shortlist.
  • catalog/README.md:3 says "Copy TEMPLATE.md to add entries"; CONTRIBUTING uses npm run new-entry, which also fills the date and checks the id is unique.
  • catalog/README.md:18 omits docs/shipping.md, docs/data.md and docs/for-publishers.md (all listed in the README guide table).
  • The internal site-refresh plan cites docs/superpowers/specs/...; the file is now under docs/internal/superpowers/specs/.

Impact

Readers miss filters that exist; contributors skip the scaffold that prevents id collisions.

Suggested fix

Update each item in the checklist.

Acceptance criteria

  • Every checklist item fixed

Getting started

  • Relevant files: README.md, catalog/README.md
  • Run the tests: npm test; the full local gate is npm run check (Node 22+, no install step)
  • Related docs: CONTRIBUTING.md, site/README.md

Filed by repo-audit/full-audit at 4adb944. Severity: low. Effort: S. audit-key: documentation|README.md|filters-list

Lenguaje dominante
JavaScript
Estrellas
58
Forks
15
Merge medio
1 d 15 h
PR fusionados (30 d)
12

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 TMHSDigital/Free-Game-Dev-Assets

Todos los issues de TMHSDigital/Free-Game-Dev-Assets

Issues similares

Más issues de JavaScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.