Skip to content

CL-6529: Fix false inference-catalog claim, posix-tools.md fiction, fold structural checks into check - #262

Merged
TheGreatAxios merged 1 commit into
mainfrom
cl-docs-danger-fix
Aug 21, 2026
Merged

CL-6529: Fix false inference-catalog claim, posix-tools.md fiction, fold structural checks into check#262
TheGreatAxios merged 1 commit into
mainfrom
cl-docs-danger-fix

Conversation

@TheGreatAxios

Copy link
Copy Markdown
Contributor

Summary

Three fixes, timeboxed to the dangerous-doc audit — no wider docs cleanup (that's a separate scheduled pass; sibling PR #260 owns AGENTS.md/DESIGN.md, untouched here).

  • docs/model-seeding.md:65-66 claimed @intx/inference-catalog "does not exist upstream or on npm (confirmed via npm view)". It does: pinned in package.json at 0.3.0, imported directly at packages/inference-catalog/src/offering-capabilities.ts:29, and listed in VENDORED.md among the trees retired to that npm publish. A confident negative claim with fake verification is the worst shape a doc bug takes — it authorizes building something the platform already ships. Corrected the paragraph and traced how the package is actually consumed today (seedCatalogcapabilitiesForDeploymentcatalogProviders). Checked the rest of the section for anything else resting on the false premise — nothing else did.

  • docs/posix-tools.md described @corbits/posix-tools in the present tense with a tool list; the package doesn't exist anywhere in the tree. Rewrote it to say so plainly, point at the real upstream package (@intx/tools-posix — its sidecar-bundle:run_shell tool already shows up in packages/mocks/src/ollama/scenarios.ts and a vendored hub-sessions test fixture), and mark the remaining content unambiguously as an unimplemented design proposal.

  • Structural check drift. bun run check ran only typecheck/lint/test; the twelve check:* structural gates ran only in CI. Three weeks of history show repeated hotfix commits (check:licenses, check:ui-vocabulary, check:tailwind-source, check:packages, check:killdates, check:react-ui-drift) plus six format-only "so lint passes on main" commits — all round-trips a local check would have caught. Added check:structural (the eleven lightweight gates) and folded it into check.

    check:packages is deliberately excluded from the default check. It builds and packs every workspace package in isolation (bun pm pack + consumption from a staging dir) — genuinely heavy, and the dev machine has been memory-constrained all week. Folding it in wholesale would make check slow enough that people stop running it, which defeats the point. Added check:all (check + check:packages) for anyone who wants full CI parity locally.

Linear: CL-6529

Test plan

  • bunx prettier --write on all three changed files (no changes needed — already formatted)
  • python3 -c "import json; json.load(open('package.json'))" — valid JSON
  • Verified @intx/inference-catalog pin, import, and VENDORED.md entry directly in the tree before editing
  • Verified @corbits/posix-tools has zero references outside the doc, and @intx/tools-posix is real (referenced in test fixtures)
  • CI (bun run check locally not run — dev machine memory-constrained per team convention; relying on CI's existing per-gate steps, which are unchanged)

…x posix-tools.md fiction, fold structural checks into check

model-seeding.md claimed @intx/inference-catalog does not exist; it is
pinned in package.json and imported directly by
packages/inference-catalog/src/offering-capabilities.ts. Corrected the
claim and described how the package is actually consumed.

posix-tools.md described @corbits/posix-tools as shipped, with a tool
list, but the package exists nowhere in the tree. Rewrote it to state
plainly nothing ships under that name, point at the real upstream
@intx/tools-posix, and mark the rest as an unimplemented design note.

bun run check only ran typecheck/lint/test; the twelve check:*
structural gates ran only in CI, and three weeks of git history show
repeated hotfix/format-only commits a local check would have caught.
Added check:structural (the eleven lightweight gates) and folded it
into check. check:packages builds and packs every workspace package
and is genuinely heavy, so it stays out of the default check; added
check:all for full CI parity locally.
@TheGreatAxios
TheGreatAxios merged commit d2699a7 into main Aug 21, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant