docs: fix stale documentation - #5113
Merged
Merged
Conversation
Correct statements contradicted by the code: the anti-slop backlog counts, a missing chat provider and flag, an env var name, and a node-source path plus a symbol that no longer exist. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
A correction pass over
docs/**,AGENTS.md, and per-packageREADME.md/AGENTS.md. Markdown only; no code was changed.Corrections
AGENTS.md— anti-slop backlog table is stale (9 rows) andtools/oxlint/anti-slop/README.mdrepeats the totalrequire-safety-comment-for-type-assertion7039,no-unsafe-dictionary-type4315,no-unknown-parameters1948,no-module-mocking1460,no-known-value-widening722,no-runtime-typeof534,no-implicit-return-type449,no-unknown-returns243,no-chained-type-assertions50.npm run lint:anti-slop:count— the command the table itself names as its regenerator. Output:16912 findings across 9 rules and 59 trees (5129 files scanned). 247 / 531 (rule, tree) pairs at zero (46.5%).The prose sentence quoting
no-module-mockingas "1,460 findings" was updated to match, and the same total was corrected intools/oxlint/anti-slop/README.md.AGENTS.md— "finished in fifty-five packages" contradicts its own tableno-module-mocking, which the same table records as zero in 56 of 59 trees. The three non-zero trees are the app trees, not packages:web1186 +electron191 +mobile94 = 1471, the rule's whole total, so all 56 packages are at zero.lintableTrees()inscripts/anti-slop-ratchet.mjsenumeratespackages/*that have asrc/plusweb,electron,mobile;ls -d packages/*/src | wc -lis 56, giving 59 trees. Per-tree counts fromnpx oxlint --config .oxlintrc.anti-slop.json <tree>.AGENTS.md—nodetool-chatprovider list omitsmeta, flag list omits--no-read-only-search... cerebras, alibaba, together, ...; flags stop at-u, --url.KNOWN_PROVIDERSinpackages/cli/src/providers.ts:46has 25 entries and includesmetabetweengmiandalibaba. The CLI also accepts--no-read-only-search("Disable the read-only run_search fan-out primitive (on by default)").node ./packages/cli/dist/index.js --help, which prints the provider list fromKNOWN_PROVIDERS.join(", ")(packages/cli/src/index.ts:52), and reading the constant.docs/DEVELOPMENT_STANDARDS.md:282— wrong env var nameWS_IDLE_TIMEOUT_MS(configurable)."NODETOOL_WS_IDLE_TIMEOUT_MS, default 70000. There is noWS_IDLE_TIMEOUT_MSanywhere in the tree.packages/websocket/src/lib/ws-connection-health.ts:42—idleTimeoutMs: parseIntEnv("NODETOOL_WS_IDLE_TIMEOUT_MS", 70_000). Matchesdocs/configuration.md:435, which already documented the correct name.docs/developer/node-patterns.md:365— a directory and a symbol that no longer existpackages/base-nodes/src/nodes/directory no longer holds individual node sources — it now only re-exports/aggregates", and "(e.g.,CONTROL_NODES,TEXT_NODES)".packages/base-nodes/src/contains onlyindex.tsandplatforms/, andindex.tsis what re-exports and aggregates (intoALL_BASE_NODES). There is noTEXT_NODESexport; the text package's array isTEXT_EXTRA_NODES(packages/text-nodes/src/nodes/text-extra.ts:989).CONTROL_NODESis real.ls packages/base-nodes/src/, readingpackages/base-nodes/src/index.ts, andgrep -rn "export const .*_NODES" packages/text-nodes/src/.Checked and found correct
Recording these so the next pass can skip them. All were verified mechanically, not by eye.
nodetool …invocation and flag in the docs. Dumped recursive--helpfor all 191 commands and subcommands frompackages/cli/dist/nodetool.jsand diffed it against every invocation in the Markdown. No unknown command, subcommand, or flag survived review — the earlier hits were all positional arguments or trailing#comments.npm run …in the docs against the root and per-workspacepackage.jsonscripts. The only miss isnpm run redeployinAGENTS.md:545, which the sentence itself describes as decommissioned.{#anchor}ids.NODETOOL_*env var named in the docs, and every documented default in thedocs/configuration.mdtables, against the code that reads them (8388608,268435456,1073741824,720000,300000,600000,8192, the Ollama URL, and the rest). All correct.AGENTS.mdanddocs/javascript-sandbox.md, against each pack'snodetool.sandboxModules[].kind. All 38 correctly classified in both.AGENTS.md: 56 workspace packages, 38 sandbox packs, 68 flow namespaces, 424 flow nodes, 7 rules at zero everywhere, 11 trees at zero on all 9 rules, 531 pairs, 247 at zero, 11 tool-loop eval suites. All correct.packages/models/README.md, the 13ui_storyboard_*tools indocs/creative-agent.md, dependency order inAGENTS.md, and version claims (Node 22.22.1, Electron 39.8.10, React 19.2, MUI v7.3, ReactFlow 12.11, RN 0.85 / Expo 56 / TS 6). All correct.Out of scope, but wrong — worth a follow-up
Neither is in this PR's stated scope (
docs/**,README.md,AGENTS.md, per-packageAGENTS.md/README.md), so I left both alone.web/src/components/ui_primitives/STRATEGY.md— the "Current State (Audit Results)" table lists raw-MUI migration targets as<Typography>201 files,<Tooltip>146,<Button>103,<IconButton>72,<CircularProgress>55,<Dialog>44,<TextField>40,<Select>37,<Chip>37,<Divider>30,<Alert>14,<Paper>12,<Tabs>10. All of them are now zero. Scanning all 1954 non-test files inweb/srcoutsideui_primitives/andeditor_ui/for named imports from@mui/materialand default imports from@mui/material/<Component>finds no banned component anywhere; the only remaining@mui/materialimports areuseTheme,Theme,ThemeProvider,useMediaQueryand theAlertColortype. The migration is finished and the doc still reads as a backlog. (display: flexinline is 340 files against a claimed 314, so that row moved the other way.).github/copilot-instructions.md— claims React 18.2, Vite 6, Electron 35.7.5, and RTL 16.1.0. Actual: React 19.2.7, Vite 8.0.16, Electron 39.8.10, RTL 16.3.2.Code that contradicts its own docs
packages/cli/src/harness/registry.ts— theevalharness entry describes the suites as... subtask, codeact, tool-loop×8, app-build, sonodetool harness listprintstool-loop×8. There are eleven tool-loop suites (tool-loop,workflow-escalation,script-tools,jsscript-tools,sketch-tools,timeline-tools,storyboard-tools,model3d-tools,app-tools,thread-memory-tools,creative-pipeline), whichnodetool eval --helpconfirms and whichAGENTS.mdalready states correctly. Left alone — fixing it means editing code.🤖 Generated with Claude Code