Skip to content

docs: fix the three accuracy gaps blocking a clean release - #540

Merged
interacsean merged 2 commits into
mainfrom
claude/docs-skill-accuracy-checks-883e45
Sep 17, 2026
Merged

interacsean merged 2 commits into
mainfrom
claude/docs-skill-accuracy-checks-883e45

Conversation

@interacsean

Copy link
Copy Markdown
Contributor

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.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 — at lines 55, 99 and 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 (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 into docs-update.lock.yml.

2. quality-check skill — align with what CI actually runs

The skill listed type-check, lint, test and fmt. .github/actions/ci also runs check-dts and gates on fmt: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-dts is the one that matters: type-check sets skipLibCheck: true and never inspects the emitted declarations, so a .d.ts that only breaks for consumers fails there and nowhere else.

3. green-suns-sing changeset — drop astw: from the Spinner example

The example used className="astw:size-3", which contradicts calm-wolves-rest.md in the same release and is rejected by the no-astw-prefix rule shipping alongside it in @tailor-platform/eslint-plugin-app-shell.

Spinner has a real size prop and xs resolves to 12px — the same result astw:size-3 was producing — so the example now reads size="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

Verification

  • pnpm fmt:check — clean
  • pnpm 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 OK
  • Bundled skill regenerated from catalogue/ — no drift

🤖 Generated with Claude Code

…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>
@interacsean
interacsean requested a review from a team as a code owner September 17, 2026 01:08
@github-actions

github-actions Bot commented Sep 17, 2026

Copy link
Copy Markdown
Contributor

Code Metrics Report

main (956d728) #540 (037ff56) +/-
Coverage 87.4% 87.4% 0.0%
Test Execution Time 2m6s 1m43s -23s
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

@interacsean
interacsean merged commit c60dbf7 into main Sep 17, 2026
5 checks passed
@interacsean
interacsean deleted the claude/docs-skill-accuracy-checks-883e45 branch September 17, 2026 01:56
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.

2 participants