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

site: generate a changelog page and the README "Recent" block from docs/review-ledger.md

Aperta
  • Qualcosa non va?
#91 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à
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
52/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
javascript
Ambito
documentation, full-stack

Direzione di ricerca

Read build.mjs, sync-counts.mjs, site/lib/markdown.mjs, and lib.test.mjs to understand the existing site build, rendering, and README update patterns. Then inspect docs/review-ledger.md, README.md, and ROADMAP.md to trace the source format and completion criteria. Done means /changelog/ is generated and linked, the README Recent block comes from the ledger, parser coverage is added, and the roadmap item is marked Done.

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

Descrizione

documentation enhancement priority: medium

Why it matters
docs/review-ledger.md is a 1,300-line, well-structured record of every sweep, but it is invisible from the site and the README. The README's "Recent:" blockquote restates three of its entries by hand and will drift. A changelog page gives returning visitors a reason to come back, shows contributors what a good sweep looks like, and is already under "Planned" in ROADMAP.md.

Evidence

  • ROADMAP.md, Planned: "A changelog page generated from docs/review-ledger.md".
  • README.md ~lines 50-53, the hand-maintained "Recent:" block.
  • The ledger uses a strict shape (## YYYY-MM-DD (title) then bullets), so it parses with site/lib/markdown.mjs.

Suggested approach

  1. In build.mjs, split the ledger on ## date headings, render the newest N sections with the existing renderer, write dist/changelog/index.html with the shared page shell, and add it to the sitemap, footer and llms.txt.
  2. Have sync-counts.mjs (or a sibling step) rewrite the README "Recent:" block from the three newest ledger headings, the same way it rewrites counts, so it cannot drift.
  3. Optionally emit changelog.xml as a second Atom feed.

Done when
/changelog/ is live and linked, the README block is generated, lib.test.mjs covers the ledger parser, and the ROADMAP item moves to Done.

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.