chore(tsdoc): ongoing-dev TSDoc skill, auditor agent, and guides#2263
Merged
Conversation
…tor agent Replaces the one-time-backfill tsdoc agents/skills with primitives suited for regular development: - Add `tsdoc` skill: inline writer invoked with `/tsdoc` after writing new code; loads type-specific guides on demand; knows when to ask for product context rather than guessing - Add `tsdoc-auditor` agent: batch reviewer/fixer for drift detection after refactors; handles both missing docs and stale comments - Add `.claude/tsdoc-guides/` with hooks, components, and flows guides: type-specific knowledge (loading/ready branches, events tables, fields.tsx patterns) loaded selectively rather than always in context - Update CLAUDE.md: exports require TSDoc before work is done - Update migrate-sdk-component-to-hooks: section 11 now uses `/tsdoc` instead of the deprecated sdk-hook-documenter agent - Delete tsdoc-api-documenter, tsdoc-backfill, sdk-hook-documenter agents - Delete tsdoc-directory skill (tsdoc-auditor handles batch work directly) Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Re-enables require-comment, require-member-comment, and require-release-tag under tsdoc-coverage. These were dropped in a prior merge commit and need to be enforced before autogenerating more TSDoc. Currently 0 errors. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…tags Brings the tsdoc skill in line with current main: - Fix stale skill description: point to the tsdoc-auditor agent (the tsdoc-directory skill was deleted) for batch drift audits - Document @group tags in SKILL.md: optional but expected on @public exports, with the lint-enforced valid set (valid-group rule) - components guide: component props now extend BaseComponentInterface<'Namespace.Component'> (#2238). Document only own/narrowed members, not inherited base members; cover the defaultValues-narrowing exception and the `@param props - See {@link XxxProps}.` convention Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Prepares the skill for the doc-generation engine landing in #2260: - @components block tag: registered TSDoc tag listing a flow's composed blocks/hooks as {@link} refs; renders a Sub-components table. Documented in SKILL.md (tag order: own group after @remarks, before @param) and in the flows guide as the primary user - GUIDE.md prose slot: note in flows and hooks guides that long-form narrative lives in a colocated, Prettier-exempt GUIDE.md slotted into the generated reference page, kept distinct from concise @remarks. Flagged that GUIDE.md authoring conventions are still being set in follow-up guide-content PRs, so don't backfill prose speculatively Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
serikjensen
approved these changes
Jun 24, 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
2 participants
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.
Summary
Replaces the one-time TSDoc backfill tooling with primitives for ongoing development, restores lint rules lost in a merge, and brings the guidance in line with current main + the doc-generation engine in #2260.
Skill/agent/guides only — no
src/or generated-doc changes.Commits
/tsdocinline writer skill, thetsdoc-auditoragent for batch drift audits, and.claude/tsdoc-guides/(hooks/components/flows) loaded on demand. Deletes thetsdoc-api-documenter,tsdoc-backfill,sdk-hook-documenteragents and thetsdoc-directoryskill.require-comment,require-member-comment,require-release-tag(currently 0 errors), needed before autogenerating more comments.@grouptags — props now extendBaseComponentInterface<'Namespace.Component'>; document only own/narrowed members;@param props - See {@link XxxProps}.convention; the lint-enforced@groupvalid set.@componentstag + GUIDE.md prose slot (feat(docs-site): theme reference diagrams and render @components / GUIDE prose #2260) — documents the new@componentsblock tag (renders the Sub-components table) and notes the colocatedGUIDE.mdprose slot. GUIDE.md authoring conventions are intentionally left light — they're being set in the follow-up guide-content PRs.Notes
main(refactor!: use interfaces for component props types #2238 interfaces-for-props, thevalid-grouprule) and the engine in feat(docs-site): theme reference diagrams and render @components / GUIDE prose #2260.🤖 Generated with Claude Code