Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

docs: ROADMAP.md contradicts the stacks, the feeds and a closed issue, and one sentence is broken

Closed
  • Is something wrong?
#145 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
56/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
github, javascript
Domain
devtools, documentation

Research direction

Read ROADMAP.md, compare its claims with stacks/, site/README.md, site/lib/exports.mjs, and the referenced issues. Rewrite the three sections with current facts, move older Done items to docs/review-ledger.md, and add a check in the monthly re-verify workflow that ROADMAP issue references remain open. Done when ROADMAP has no contradictions and its broken sentence is whole.

Written by the indexing model from the issue text.

Description

documentation priority: medium

Why it matters

ROADMAP is where CONTRIBUTING and the README send new contributors to find work. #69 fixed an earlier round of the same drift, so a guard is worth adding this time.

Evidence (at 69387df)

  • ROADMAP.md:14: "Starter stacks: audio, a game-jam kit, Unity, Unreal and VR are not covered yet." stacks/3d-third-person-unreal.md exists and is linked from README.md:147 and the homepage.
  • ROADMAP.md:11-13 offers #41 (camera_perspective / grid_dimensions) as "a good first PR"; #41 is closed and camera_perspective is set on 50 entries. The remaining gap is open #98.
  • ROADMAP.md:21-22: the inserted sentence about reverify.yml splits the original one, leaving the fragment "together in mid-2027." dangling on line 22.
  • ROADMAP.md:33-34 says feed.xml is "of recently verified entries"; site/README.md:26-30 and site/lib/exports.mjs:103-109 say feed.xml is new sources by added and reverified.xml is the verified feed.
  • ROADMAP.md:8 names the thin categories as "video, animation and environment"; shaders-vfx (18) is now tied with animation (18), both below environment (20).

Suggested approach

Rewrite the three sections with today's facts; replace issue numbers with label links (good first issue, gap) so the file does not go stale when issues close; move "Done" items older than a quarter into docs/review-ledger.md. Add a small check (a gh call in the monthly re-verify workflow is enough) that every #N in ROADMAP is still open.

Done when

No sentence in ROADMAP contradicts stacks/, site/README.md or the issue tracker; the broken sentence is whole.

Dominant language
JavaScript
Stars
58
Forks
15
Avg merge
16h 53m
Merged PRs (30d)
14

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.