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

feature: render the guides as site pages instead of bouncing readers to GitHub markdown

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

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

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

Research direction

Start with site/public/index.html and site/public/app.js to trace the Guides links, then read site/lib/markdown.mjs and site/config.json to see how pages and guide files are built. Check how the shared head builder, sitemap, llms.txt, and entry facts panel are generated. Done means all ten guides render in dist, are linked from the home Guides section and matching entry facts, retain an Edit on GitHub link, and Lighthouse SEO remains at 100.

Written by the indexing model from the issue text.

Description

feature priority: medium

Why it matters

"Guides" is one of four primary nav items, and the hero promises "Every licence read at the source"; the moment a visitor wants to understand CC-BY vs OFL or the high-risk list, they are sent to github.com with no site nav, search, theme or shortlist. The entry pages' "Entry and evidence" link does the same. Rendered guides also give the entry facts panel somewhere to link a licence name to.

Evidence (at 69387df)

  • site/public/index.html:196-202 #guide-list; site/public/app.js:582-589 builds ${repo}/blob/main/${g.path} links; site/config.json lists ten guides.
  • site/lib/markdown.mjs already renders markdown bodies for entry pages, and the shared head builder gives every page the same head, nav and footer, so the build cost is one more page type.

Suggested approach

Build guide/<id>/ from docs/<file>.md with the site head, nav and breadcrumb; add them to sitemap.xml and llms.txt; link licence names in the entry facts panel to the matching guide anchor (for example "CC-BY 4.0" -> guide/licenses/#cc-by); keep "Edit on GitHub" as a secondary link.

Done when

Ten guide pages in dist, linked from the home Guides section and from entry facts; Lighthouse SEO stays at 100.

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.