Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

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

Aperta
  • Qualcosa non va?
#159 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à
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
66/100
Tipo di issue
Funzionalità
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
javascript
Ambito
documentation

Direzione di ricerca

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.

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

Descrizione

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.

Lingua principale
JavaScript
Stelle
58
Fork
15
Merge medio
16h 53m
PR unite (30g)
14

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.