docs: correct three package and editor docs against source - #1406
Merged
Conversation
**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
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.
Third slice of the docs audit, finishing the previously-unread files:
editors/,packages/*READMEs,posts/, anddocs/design/.Both editor READMEs advertise a feature that does not exist
vscode and zed each list:
No shipped lexicon implements
codeActionProvider, so the language server never advertises the capability. Loading all twelve and asking: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
bun:testimport exists in the package; every module imports from vitest, which is what the repo runs.| `examplesDir` | `string` | Directory to scan (use `import.meta.dirname|— missing the closing backtick, the paren and the final pipe, so the table renders broken.describeObservationConformanceis the observation contract's enforcement half (fix(core): observation contract — "not observed" is silently "not present" #1089), run by seven lexicons and extended in Lexicon contract: ownership marker channel is an obligation with no declaration and no check #1348 — a reader looking for it would not have found it here. Added, along with a table covering the mock factories, the static observation helpers, and the temp-directory utilities.SPRAWL-VALIDATION.md — four broken links
../../../../../examples/gitlab-aws-alb-api/src/pipeline.ts../too many./pilots/pilots-e2e.test.ts×3pilots.test.ts./verbs/apply.tscreateLambdaDeployCapabilitylives inlexicons/aws/src/components/apply.tsVerified clean
packages/k8s-client/README.md—chant kubeis real (the k8s plugin'scommands()returnskubeCommandGroup()), the optional dependency is declared as claimed, and the "never importable from the build path" claim is backed byexamples/k8s-client-boundary.test.tspackages/core/src/components/README.md—chant graph --stacksis a real flagposts/anddocs/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