README and catalog/README give incomplete filter and guide lists

Ouverte Adaptée aux débutants
  • Quelque chose ne va pas ?
#270 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Les mainteneurs répondent en général sous 1 jour

Personne n'a encore pris cette issue.

Évaluation

Difficulté
2/5
Temps estimé
1-3 heures
Accessibilité débutants
78/100
Type d'issue
Documentation
Clarté
Clairement spécifiée
Activité
Active
Stack technique
javascript
Domaine
documentation

Piste de recherche

Lis les sections indiquées dans README.md et catalog/README.md, puis consulte dans CONTRIBUTING.md le processus npm run new-entry et le tableau des guides de README. Mets à jour les chemins du plan interne de rafraîchissement du site sous docs/internal/superpowers/plans/ pour qu’ils pointent vers docs/internal/superpowers/specs/. Le travail est terminé lorsque les quatre éléments de la liste de contrôle sont corrigés ; l’issue indique npm test et npm run check comme commandes de vérification.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

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

Langage dominant
JavaScript
Étoiles
58
Forks
15
Merge moyen
1 j 15 h
PR mergées (30 j)
12

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de TMHSDigital/Free-Game-Dev-Assets

Toutes les issues de TMHSDigital/Free-Game-Dev-Assets

Issues similaires

Plus d'issues JavaScript

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.