README and catalog/README give incomplete filter and guide lists

Aperta Adatta ai principianti
  • Qualcosa non va?
#270 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
78/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
javascript
Ambito
documentation

Direzione di ricerca

Leggi le sezioni indicate in README.md e catalog/README.md, poi consulta in CONTRIBUTING.md il flusso di lavoro npm run new-entry e la tabella delle guide di README. Aggiorna i percorsi del piano interno di aggiornamento del sito in docs/internal/superpowers/plans/ affinché puntino a docs/internal/superpowers/specs/. Il lavoro è terminato quando tutti e quattro gli elementi della checklist sono corretti; l’issue indica npm test e npm run check come comandi di verifica.

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

Descrizione

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

Lingua principale
JavaScript
Stelle
58
Fork
15
Merge medio
1g 15h
PR unite (30g)
12

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

Tutte le issue di TMHSDigital/Free-Game-Dev-Assets

Issue simili

Altre issue su JavaScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.