Hacktoberfest 2026: die Issues, die Maintainer für den Oktober markiert haben – offen und einsteigerfreundlich. Hacktoberfest-Issues durchsuchen

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

Offen
  • Stimmt etwas nicht?
#159 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 1 Tag

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Anfängerfreundlichkeit
66/100
Issue-Typ
Feature
Klarheit
Klar beschrieben
Aktivitätsstatus
Aktiv
Tech-Stack
javascript
Bereich
documentation

Rechercherichtung

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.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

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.

Vorherrschende Sprache
JavaScript
Sterne
58
Forks
15
Ø Merge
16 Std. 53 Min.
Gemergte PRs (30 T.)
14

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus TMHSDigital/Free-Game-Dev-Assets

Alle Issues in TMHSDigital/Free-Game-Dev-Assets

Ähnliche Issues

Weitere Issues zu JavaScript

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.