Hacktoberfest 2026: as issues que os mantenedores marcaram para outubro, abertas e boas para iniciantes. Ver issues do Hacktoberfest

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

Fechada
  • Algo errado?
#146 0 comentários 0 reações 0 responsáveis Ver no GitHub

Mantenedores costumam responder em até 1 dia

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
4/5
Tempo estimado
3-5 dias
Facilidade para iniciantes
42/100
Tipo de issue
Documentação
Clareza
Razoavelmente clara
Status de atividade
Ativa
Stack de tecnologia
javascript
Domínio
documentation

Direção de pesquisa

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.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

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.

Linguagem predominante
JavaScript
Estrelas
58
Forks
15
Merge médio
16h 53min
PRs com merge (30d)
14

Preparar o ambiente

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de TMHSDigital/Free-Game-Dev-Assets

Todas as issues de TMHSDigital/Free-Game-Dev-Assets

Issues semelhantes

Mais issues de JavaScript

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.