Skip to content

docs: correct three package and editor docs against source - #1406

Merged
lex00 merged 1 commit into
mainfrom
docs/test-utils-readme
Aug 3, 2026
Merged

docs: correct three package and editor docs against source#1406
lex00 merged 1 commit into
mainfrom
docs/test-utils-readme

Conversation

@lex00

@lex00 lex00 commented Aug 3, 2026

Copy link
Copy Markdown
Contributor

Third slice of the docs audit, finishing the previously-unread files: editors/, packages/* READMEs, posts/, and docs/design/.

Both editor READMEs advertise a feature that does not exist

vscode and zed each list:

  • Code actions — quick fixes from chant lint rules

No shipped lexicon implements codeActionProvider, so the language server never advertises the capability. Loading all twelve and asking:

plugins loaded: 12
completionProvider advertised: true
hoverProvider advertised: true
codeActionProvider advertised: undefined

The seam is real and core dispatches through it (#1349) — nothing fills it. Both READMEs now say that plainly rather than promising the feature.

test-utils README

SPRAWL-VALIDATION.md — four broken links

Link Problem
../../../../../examples/gitlab-aws-alb-api/src/pipeline.ts one ../ too many
./pilots/pilots-e2e.test.ts ×3 a filename that has never existed; the tests described are in pilots.test.ts
./verbs/apply.ts createLambdaDeployCapability lives in lexicons/aws/src/components/apply.ts

Verified clean

  • packages/k8s-client/README.mdchant kube is real (the k8s plugin's commands() returns kubeCommandGroup()), the optional dependency is declared as claimed, and the "never importable from the build path" claim is backed by examples/k8s-client-boundary.test.ts
  • packages/core/src/components/README.mdchant graph --stacks is a real flag
  • relative links in the remaining package, post and design docs all resolve

posts/ and docs/design/ are point-in-time narrative documents, so I checked their links and commands rather than treating drift from current behavior as an error.

🤖 Generated with Claude Code

https://claude.ai/code/session_01Jp6SP7ZiavhoEB1AFuwwoJ

**Both editor READMEs advertised a feature the LSP never offers.** vscode and
zed each list "Code actions — quick fixes from chant lint rules". No shipped
lexicon implements `codeActionProvider`, so `computeCapabilities` never sets it
— loading all twelve and asking gives `completionProvider: true`,
`hoverProvider: true`, `codeActionProvider: undefined`. The seam exists and core
dispatches through it (#1349); nothing fills it. Both now say so instead.

**test-utils README said "Designed for Bun's test runner."** There is not one
`bun:test` import in the package; every module imports from vitest, which is
what the repo runs. It also had a table row truncated mid-cell —
`Directory to scan (use `import.meta.dirname|` — which renders as a broken
table, and documented three of the package's exports while omitting the rest.
`describeObservationConformance` in particular is the observation contract's
enforcement half that seven lexicons run, and a reader looking for it would not
have found it here. Added it, plus a table for the mock factories and the
temp-directory helpers.

**SPRAWL-VALIDATION.md had four broken relative links.** One `../` too many on
the gitlab example, three to `pilots/pilots-e2e.test.ts` — a filename that has
never existed, where the tests described live in `pilots.test.ts` — and one to
`verbs/apply.ts` for `createLambdaDeployCapability`, which is in
`lexicons/aws/src/components/apply.ts`.

Verified clean while here: k8s-client's README (`chant kube` is real via the
plugin's command group, the optional dependency is declared, the import
boundary is tested), components/README's `chant graph --stacks`, and the
relative links in the remaining package, post and design docs.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Jp6SP7ZiavhoEB1AFuwwoJ
@lex00
lex00 merged commit f62fa08 into main Aug 3, 2026
9 checks passed
@lex00
lex00 deleted the docs/test-utils-readme branch August 3, 2026 19:21
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