docs: fix the three accuracy gaps blocking a clean release - #540
Merged
Merged
Conversation
…rop astw: from the Spinner changeset Three pre-publish accuracy fixes, all in files that steer other agents or land in published release notes. **CLAUDE.md — Documentation Index.** `.github/workflows/docs-update.md` tells the Documentation Updater to use a "Documentation Index" in CLAUDE.md to route a changeset to the right doc file, and to register new pages there (lines 55, 99, 105). That section was removed in #128 when docs/ was split from six files into seventy, so the agent has been routing blind ever since. Restored as a convention table rather than the old hand-written file list — docs/ is organised by kind, so the table stays correct as pages are added and needs no edit per page. The prompt is runtime-imported from the .md, so this needs no gh-aw lock recompile. **quality-check skill.** Listed type-check, lint, test and fmt; CI (.github/actions/ci) also runs check-dts and gates on fmt:check. Both added, with a note to keep the two lists in step — a task that runs in CI but not in the skill passes locally and fails on the PR. **green-suns-sing changeset.** The Spinner example used `className="astw:size-3"`, which contradicts calm-wolves-rest in the same release and is rejected by the no-astw-prefix rule shipping alongside it. Spinner has a real `size` prop and `xs` is 12px, so the example now shows `size="xs"` — the same result through the supported API. Caught before publish: the text was already rendered into the Version Packages PR (#524) and freezes on release. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Contributor
Code Metrics Report
Details | | main (956d728) | #540 (037ff56) | +/- |
|---------------------|----------------|----------------|------|
| Coverage | 87.4% | 87.4% | 0.0% |
| Files | 204 | 204 | 0 |
| Lines | 6014 | 6014 | 0 |
| Covered | 5257 | 5257 | 0 |
+ | Test Execution Time | 2m6s | 1m43s | -23s |Reported by octocov |
IzumiSy
approved these changes
Sep 17, 2026
This was referenced Sep 17, 2026
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.
Three fixes in files that steer other agents or land in published release notes. Found while auditing how docs and skills stay current ahead of the pending release.
1.
CLAUDE.md— restore the Documentation Index.github/workflows/docs-update.mdtells the Documentation Updater to use a "Documentation Index" inCLAUDE.mdto route a changeset to the right doc file, and to register new pages there — at lines 55, 99 and 105. That section was removed in #128 whendocs/was split from six files into seventy, so the agent has been routing blind ever since.Restored as a convention table rather than the old hand-written file list.
docs/is organised by kind (components/,api/,concepts/), so the table stays correct as pages are added and needs no edit per page — the old enumerated list is exactly what rotted last time.No gh-aw lock recompile needed: the prompt body is
runtime-imported from the.md(GH_AW_PROMPT_CONTENT_0005), not baked intodocs-update.lock.yml.2.
quality-checkskill — align with what CI actually runsThe skill listed type-check, lint, test and
fmt..github/actions/cialso runscheck-dtsand gates onfmt:check. Both are now in the procedure, with a note to keep the two lists in step — a task that runs in CI but not in the skill passes locally and fails on the PR.check-dtsis the one that matters:type-checksetsskipLibCheck: trueand never inspects the emitted declarations, so a.d.tsthat only breaks for consumers fails there and nowhere else.3.
green-suns-singchangeset — dropastw:from the Spinner exampleThe example used
className="astw:size-3", which contradictscalm-wolves-rest.mdin the same release and is rejected by theno-astw-prefixrule shipping alongside it in@tailor-platform/eslint-plugin-app-shell.Spinnerhas a realsizeprop andxsresolves to 12px — the same resultastw:size-3was producing — so the example now readssize="xs", through the supported API.This one is time-sensitive. The text is already rendered into the CHANGELOG on the open Version Packages PR (#524) and freezes on publish. This PR needs to land before #524 merges; changesets will regenerate #524 once it does.
Not in this PR
astw:prose acrossdocs/is already covered by fix(core): correct astw: prefix order in shipped components, and the prefix advice in docs/ #515.Spinner, plus nine exports with no mention anywhere indocs/) are the Documentation Updater's job once it is poked — it has been failing since Sep 11 and last produced a PR on Sep 8, which is why the gap went unflagged.Verification
pnpm fmt:check— cleanpnpm exec turbo run lint test type-check check-dts— 25 tasks, 97 test files, 1800 tests, all passing.github/workflows/scripts/check-catalogue-links.sh— 28 pages OKcatalogue/— no drift🤖 Generated with Claude Code