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

Ouverte Adaptée aux débutants
  • Quelque chose ne va pas ?
#178 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Les mainteneurs répondent en général sous 1 jour

Personne n'a encore pris cette issue.

Évaluation

Difficulté
2/5
Temps estimé
1-3 heures
Accessibilité débutants
82/100
Type d'issue
Documentation
Clarté
Clairement spécifiée
Activité
Active
Stack technique
markdown
Domaine
documentation

Piste de recherche

Lisez ROADMAP.md, docs/data.md et docs/high-risk.md en parallèle des tickets cités et de l’état des versions et des tags. Mettez à jour la feuille de route et les indications de version pour qu’elles correspondent à ce qui a été publié, et révisez le guide High-risk pour les lecteurs utilisant des liens vers les pages d’entrée. Le travail est terminé lorsque les pages correspondent à l’état actuel du projet et que le guide ne contient ni jargon de workflow ni chemins du dépôt.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

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.

Langage dominant
JavaScript
Étoiles
58
Forks
15
Merge moyen
1 j 7 h
PR mergées (30 j)
12

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de TMHSDigital/Free-Game-Dev-Assets

Toutes les issues de TMHSDigital/Free-Game-Dev-Assets

Issues similaires

Plus d'issues JavaScript

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.