docs: the README is ~400 lines; trim it to first-visit essentials and move engine and field reference to docs/
維護者通常 1 天內回覆
還沒有人認領這個 Issue。
評估
- 難度
- 3/5
- 預估耗時
- 1-2 天
- 新手友好度
- 72/100
- Issue 類型
- 文件
- 描述清晰度
- 描述清楚
- 活躍度
- 活躍
- 技術堆疊
- javascript
研究方向
Start with README.md and the existing references in docs/licenses.md, docs/unreal.md, docs/godot-budget-stack.md, and site/README.md; use the listed headings to identify content to move, and preserve inbound anchors with stubs and links. Run node site/validate.mjs to check relative links. Done when the README is under about 200 lines, moved content lives in docs/, and validation reports no broken links.
由索引模型根據 Issue 內容生成。
描述
Why it matters
The README is well written but long (402 lines, 24 KB, 16 sections). A first-time visitor scrolls past a gallery, two tables, "Reading an entry", "Safe starting points", "Licences", "Godot" and "Unreal Engine" before reaching Contributing, and most of that is duplicated on the site, which presents it better. A shorter README converts more visitors to the site and to a first PR.
Evidence
grep -n '^#' README.md: 16 headings; "Reading an entry" (171), "Safe starting points" (210), "Licences" (243), "Godot" (278), "Unreal Engine" (286) restate site or docs content.docs/licenses.md,docs/unreal.md,docs/godot-budget-stack.md,site/README.mdhold the long form.
Suggested approach
Keep hero, one positioning paragraph, the three-card table, one gallery row, "Start here", the stacks table, scope, a short contributing section, support and licence. Move "Reading an entry" to docs/entry-format.md, fold Godot/Unreal into their docs, reduce "Licences" to one line and a link. Target under 200 lines and keep every inbound anchor (stub plus link where one is removed).
Done when
README is under ~200 lines, node site/validate.mjs reports no broken relative links, and the moved content lives in docs/.
- 主要語言
- JavaScript
- 星號
- 58
- 分支
- 15
- 平均合併
- 16 小時 53 分鐘
- 30 天內合併 PR
- 14
環境準備
- 沒有 Dockerfile 或 Docker Compose 檔案
- 有 Pull Request 範本
- 閱讀貢獻指南
從這裡開始
- 先讀完整個 Issue，再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫，在一個分支上完成修改。
- 送出 Pull Request，並在描述裡引用這個 Issue 編號。
TMHSDigital/Free-Game-Dev-Assets 的其他 Issue
-
community marketing priority: low
難度 2/5 1-3 小時 新手友好度 72/100
TMHSDigital/Free-Game-Dev-Assets#151 ·
維護者通常 1 天內回覆
-
documentation priority: medium
難度 2/5 1-3 小時 新手友好度 78/100
TMHSDigital/Free-Game-Dev-Assets#72 ·
維護者通常 1 天內回覆
-
enhancement
難度 1/5 1-3 小時 新手友好度 68/100
TMHSDigital/Free-Game-Dev-Assets#3 · 1 則留言 ·
維護者通常 1 天內回覆
-
marketing priority: low
難度 2/5 1-3 小時 新手友好度 55/100
TMHSDigital/Free-Game-Dev-Assets#152 ·
維護者通常 1 天內回覆
-
feature priority: medium
難度 5/5 一週以上 新手友好度 25/100
TMHSDigital/Free-Game-Dev-Assets#144 ·
維護者通常 1 天內回覆
查看 TMHSDigital/Free-Game-Dev-Assets 的全部 Issue
相似的 Issue
-
bug require-triage
難度 2/5 1-3 小時 新手友好度 72/100
expressjs/expressjs.com#2549 · 1 個 reaction ·
維護者通常 1 天內回覆
-
難度 2/5 1-3 小時 新手友好度 82/100
-
難度 1/5 1 小時以內 新手友好度 85/100
維護者通常 1 天內回覆
-
難度 2/5 1-3 小時 新手友好度 72/100
vercel-labs/agent-skills#348 ·
-
難度 2/5 1-3 小時 新手友好度 65/100
NanmiCoder/dsh-agent-teams#289 ·
維護者通常 1 天內回覆