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 天内回复
-
community marketing priority: medium
难度 2/5 1-3 小时 新手友好度 78/100
TMHSDigital/Free-Game-Dev-Assets#150 ·
维护者通常 1 天内回复
-
community enhancement priority: medium
难度 2/5 1-3 小时 新手友好度 82/100
TMHSDigital/Free-Game-Dev-Assets#149 ·
维护者通常 1 天内回复
-
community documentation priority: medium
难度 1/5 1-3 小时 新手友好度 88/100
TMHSDigital/Free-Game-Dev-Assets#148 ·
维护者通常 1 天内回复
-
site: the Unreal guide is missing from the homepage Guides list, and the hero calls tools "assets"未关闭bug marketing priority: medium
难度 1/5 1-3 小时 新手友好度 85/100
TMHSDigital/Free-Game-Dev-Assets#147 ·
维护者通常 1 天内回复
查看 TMHSDigital/Free-Game-Dev-Assets 的全部 Issue
相似的 Issue
-
[ordering-review] workshop order graph: 1 confirmed ordering problem, 3 cycles are false positives未关闭
难度 2/5 1-3 小时 新手友好度 78/100
githubnext/gh-aw-workshop#4943 ·
维护者通常 1 天内回复
-
[guide] Public Sector User Group page names wrong Slack channel可能已有人在做 @hivecommons-hive 今天认领。 未关闭agent/guide documentation hive/claimed-by-guide stage/040-covered-by-pr
难度 1/5 1 小时以内 新手友好度 88/100
维护者通常 1 天内回复
-
check:passed feeds:edit
难度 1/5 1 小时以内 新手友好度 82/100
-
bug good first issue
难度 2/5 1-3 小时 新手友好度 88/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 63/100
oskarrough/dodgethis#115 ·
维护者通常 1 天内回复