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

未關閉 適合新手
#178 0 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視

維護者通常 1 天內回覆

還沒有人認領這個 Issue。

評估

難度
2/5
預估耗時
1-3 小時
新手友好度
82/100
Issue 類型
文件
描述清晰度
描述清楚
活躍度
活躍
技術堆疊
markdown
領域
documentation

研究方向

搭配引用的 issues 以及 release/tag 狀態,閱讀 ROADMAP.md、docs/data.md 和 docs/high-risk.md。更新路線圖和發布指南,使其符合已發布的內容,並修訂 High-risk 指南,供使用入口頁面連結的讀者閱讀。完成標準是這些頁面與專案目前的狀態一致,而且指南中沒有工作流程術語或儲存庫路徑。

由索引模型根據 Issue 內容生成。

描述

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.

主要語言
JavaScript
星號
58
分支
15
平均合併
1 天 7 小時
30 天內合併 PR
12

環境準備

從這裡開始

  1. 先讀完整個 Issue,再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫,在一個分支上完成修改。
  4. 送出 Pull Request,並在描述裡引用這個 Issue 編號。

TMHSDigital/Free-Game-Dev-Assets 的其他 Issue

查看 TMHSDigital/Free-Game-Dev-Assets 的全部 Issue

相似的 Issue

更多 JavaScript Issue

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。