Hacktoberfest 2026：维护者为十月标记出来的 issue，仍然开放、适合新手。 浏览 Hacktoberfest issue

docs: strip maintainer-internal and agent-session language from the public guides, refresh their stale numbers, and decide publisher grouping

已关闭
  • 哪里不对？
#146 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
4/5
预计耗时
3-5 天
新手友好度
42/100
Issue 类型
文档
描述清晰度
基本清楚
活跃度
活跃
技术栈
javascript
领域
documentation

调研方向

Start with the named guides and references: docs/provenance.md, docs/research-index.md, docs/trust-score.md, docs/ai-assets.md, docs/godot-budget-stack.md, CONTRIBUTING.md, README.md, and the site entry and homepage code. Check how catalog counts and the Guides list are built, then update or remove stale public content and resolve the publisher grouping inconsistency. Done when the guides contain no session or inaccessible-file references, their numeric claims match the catalog, and the homepage lists only user-facing guides.

由索引模型根据 Issue 内容生成。

描述

documentation priority: medium

Why it matters

Several guides read as research dumps or notes to a future agent, which undercuts the "every fact read at the source" positioning for the sceptical first-time visitor and for anyone judging whether to cite the catalog. #73 fixed specific items earlier; new instances have accrued since.

Evidence (at 69387df)

  • docs/provenance.md:42: "Kenney is twenty entries, Quaternius eight, KayKit six". Actual publisher counts: Kenney 54, Quaternius 28, KayKit 13.
  • docs/provenance.md:44: "do not add publisher grouping to the site UI unless a later session explicitly decides to". It also contradicts CONTRIBUTING.md:50, which tells contributors to set publisher "so the entries group"; in fact publisher is shown only as a label on the entry page (site/lib/entry-page.mjs:84) and there is no grouping or filter.
  • docs/research-index.md:3,15 describes files under RESEARCH/ that are gitignored since bb532cb; the whole page describes files no reader can open. CONTRIBUTING.md:98-100 repeats this.
  • docs/trust-score.md:3: "From Round 3 catalog-ops research" and "(trust tag or notes)"; no entry uses a trust tag and CONTRIBUTING.md:53 would reject it. README.md:257 says the rubric is "not shown on entries", yet the homepage lists it among the public Guides.
  • docs/ai-assets.md:3: "Synthesized from gap research (as of early 2026 claims in that brief...)"; line 8 suggests compliance:ai-disclosure, not a valid tag form.
  • docs/godot-budget-stack.md:1: title ends "(from research)".
  • docs/superpowers/plans/2026-10-23-site-refresh.md and docs/superpowers/specs/2026-10-23-site-refresh-design.md are tracked agent implementation plans sitting next to the user guides.

Suggested approach

One editing pass: replace research-provenance lines with "Last reviewed: date"; derive the publisher numbers from the build like the counts; decide publisher grouping (either add a publisher filter to the site, which 170 entries would benefit from, or soften CONTRIBUTING); delete docs/research-index.md or reduce it to one paragraph in CONTRIBUTING; move docs/superpowers/ and docs/design/ under docs/internal/ with a README line saying they are design history, and keep them out of the homepage Guides list.

Done when

No public guide mentions sessions, rounds, briefs or local files; numeric claims in guides match the catalog; the homepage Guides list contains only user-facing guides.

主要语言
JavaScript
星标
58
派生
15
平均合并
16 小时 53 分钟
30 天内合并 PR
14

环境准备

从这里开始

  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 摘要。