README, docs and tool descriptions are stale for the 0.2 surface

Aberta
#115 1 comentário 0 reações 0 responsáveis Ver no GitHub

Mantenedores costumam responder em até 2 dias

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
3/5
Tempo estimado
1-2 dias
Facilidade para iniciantes
76/100
Tipo de issue
Documentação
Clareza
Claramente especificada
Status de atividade
Ativa
Stack de tecnologia
node.js, typescript

Direção de pesquisa

Start with README.md, docs/lint.md, docs/scenes.md, docs/index.html, skills/signal-hygiene.md, src/tools/lint.ts, and BACKLOG.md; compare the listed descriptions with the source locations cited in the issue. Update the documented behavior and move signal-callback-arity to Next. Run npm run generate:tools after changing the tool description; done when the listed inconsistencies are corrected and the generated tool metadata is current.

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

Descrição

documentation severity: low

Summary

After the 0.2.0 feature work, several docs and tool descriptions are out of date. Grouped by document.

README.md

  • README:63-65 says "The lint, validate, and report tools take an optional baseline file". lint_file has no baseline argument (src/tools/lint.ts:27-33), and an MCP client sending one gets it silently stripped. Say "lint_project, the validate_* tools, and project_report".
  • README:74-76 lists five commands and leaves out gdcorrect rules [projectPath]. rules also rejects --format sarif with exit 2 (src/cli.ts:262-265), while the options table implies every format works for every command.
  • Relative baseline paths resolve against the cwd in the CLI and against the project root in MCP (src/baseline.ts:105-108, src/baseline.ts:133-138). This is not documented. It is tracked as a code issue too; document whichever rule is settled on.
  • Node.js 22 or newer is required (engines.node >=22.0.0), but neither the Installation section nor docs/index.html says so.

docs/lint.md and docs/index.html

  • docs/lint.md:24-25, docs/lint.md:168 and the CI section of docs/index.html describe exit 1 as error-severity findings only, and exit 2 as tool failure. In fact exit 1 means "findings at or above --fail-on (default error)", and exit 2 also covers usage and config errors (src/cli.ts:93-107). README and --help are already correct.
  • docs/lint.md:78-81 and the comment at src/lint/project.ts:8 say the godotVersion payload field is "the default removed-api-usage target". It is actually the raw declared version from project.godot. The target is pinnedVersionFor(declared), so a 4.6 project reports "4.6" but is checked against 4.5. Reword, or also emit the effective target.

docs/scenes.md

  • docs/scenes.md:9-12 says validate-registries returns { root, findings, count } plus entries. It actually returns { root, findings, entries } with no count (src/cli.ts:57, src/tools/scenes.ts:83).
  • docs/scenes.md:64-66: a registry value is only checked if it also contains /, ends in a resource extension, or starts with res:// (src/scenes/paths.ts:50-52). So icon_texture = "icon.png" is never checked, and uid:// strings in registries are never resolved (paths.ts:29). Document both limits.

Rule and tool descriptions

  • skills/signal-hygiene.md:33-34 and the connect-without-disconnect rule description (src/lint/rules/connect-without-disconnect.ts:11, shown by list_rules) say "no matching disconnect". The rule actually checks for any disconnect() anywhere in the file (lines 14-19), as docs/lint.md:20 correctly says.
  • The lint_file tool description says "against the default ruleset" (src/tools/lint.ts:22-26), but the tool loads the project config. Regenerate mcp-tools.json after the fix.

BACKLOG.md

  • BACKLOG.md:6 and :32 list signal-callback-arity under "## v0.2" with "Not implemented in v0.1.0". 0.2.0 ships without it; move it to "Next".

Getting started

  • Relevant files: README.md, docs/lint.md, docs/scenes.md, docs/index.html, skills/signal-hygiene.md, src/tools/lint.ts, BACKLOG.md
  • Run npm run generate:tools after changing a tool description.

Filed by repo-audit/full-audit at e836036. Severity: low. Effort: S. audit-key: documentation|README.md|0.2-surface

Linguagem predominante
TypeScript
Estrelas
0
Forks
6
Merge médio
1d 21h
PRs com merge (30d)
8

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/godot-correctness-mcp

Todas as issues de TMHSDigital/godot-correctness-mcp

Issues semelhantes

Mais issues de TypeScript

Receba novas issues na sua caixa de entrada

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