README and catalog/README give incomplete filter and guide lists

Open Beginner friendly
  • Is something wrong?
#270 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
78/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
javascript
Domain
documentation

Research direction

Read the listed sections in README.md and catalog/README.md, then check CONTRIBUTING.md for the npm run new-entry workflow and the README guide table. Update the internal site-refresh plan paths under docs/internal/superpowers/plans/ to point to docs/internal/superpowers/specs/. Done when all four checklist items are corrected; the issue names npm test and npm run check as verification commands.

Written by the indexing model from the issue text.

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

Dominant language
JavaScript
Stars
58
Forks
15
Avg merge
1d 15h
Merged PRs (30d)
12

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from TMHSDigital/Free-Game-Dev-Assets

All issues in TMHSDigital/Free-Game-Dev-Assets

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.