docs: ROADMAP lists shipped work as planned and unreleased releases as done; the High-risk guide still speaks to maintainers

Offen Anfängerfreundlich
  • Stimmt etwas nicht?
#178 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
2/5
Geschätzter Aufwand
1-3 Stunden
Anfängerfreundlichkeit
82/100
Issue-Typ
Dokumentation
Klarheit
Klar beschrieben
Aktivitätsstatus
Aktiv
Tech-Stack
markdown
Bereich
documentation

Rechercherichtung

Lies ROADMAP.md, docs/data.md und docs/high-risk.md zusammen mit den zitierten Issues und dem Status von Releases und Tags. Aktualisiere die Roadmap und die Release-Hinweise entsprechend dem, was bereits veröffentlicht wurde, und überarbeite den High-risk-Leitfaden für Leser, die Links auf Einstiegsseiten verwenden. Fertig ist die Aufgabe, wenn die Seiten dem aktuellen Projektstatus entsprechen und der Leitfaden weder Workflow-Jargon noch Repository-Pfade enthält.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

documentation priority: medium

Why it matters

These pages are what visitors read to judge whether the project is current and trustworthy. Each one below states something that is no longer true, or speaks to the maintainer rather than the reader.

Evidence

  • ROADMAP.md:26 lists "the guides rendered as site pages, and an engine filter" under planned work. Both shipped (#159, #160).
  • ROADMAP.md:37 lists "Monthly dataset releases tagged vYYYY.MM.DD" as done, but git tag and gh release list are both empty (#137 is still open).
  • docs/data.md:17 points readers to releases that do not exist yet.
  • docs/high-risk.md, now rendered at /guide/high-risk/, opens with "Do not catalog / high risk" and maintainer instructions ("Do not catalog until…"). It cites repo paths such as catalog/shaders-vfx/godot-shaders.md instead of entry pages. #146 cleaned the other guides but missed this one.

Suggested approach

  • Move the shipped items to Done, and move releases back to Planned until #137 lands.
  • Make data.md say "releases: coming", or link the raw exports instead.
  • Retitle high-risk.md for readers (e.g. "Free sources that aren't safe to ship"), rewrite its imperatives as reader advice, and link entry pages.
  • Consider a validator rule that rejects backticked catalog/... paths in public guides.

Done when

ROADMAP and data.md match the tags and closed issues, and the High-risk guide contains no workflow jargon or repo paths.

Vorherrschende Sprache
JavaScript
Sterne
58
Forks
15
Ø Merge
1 T. 7 Std.
Gemergte PRs (30 T.)
12

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.