diff --git a/.claude/skills/README.md b/.claude/skills/README.md index dee33a5e..72c17d18 100644 --- a/.claude/skills/README.md +++ b/.claude/skills/README.md @@ -17,17 +17,19 @@ Specialized knowledge for AI agents working on Video.js 10. | Reviewing accessibility | `aria` → `review/workflow.md` | | Accessibility audit | `aria` | | Committing / creating PRs | `git` | +| Updating AI docs | `claude-update` | ## Skills | Skill | Purpose | Has Review? | | ------------------------------- | ---------------------------------------------------------------------- | ----------- | | [api](api/SKILL.md) | API design and DX — extensibility, type safety, progressive disclosure | Yes | -| [docs](docs/SKILL.md) | Write Video.js 10 documentation | Yes | -| [rfc](rfc/SKILL.md) | Write RFCs — design docs, architecture proposals, component specs | No | -| [component](component/SKILL.md) | Build headless UI components — compound patterns, state, styling | Yes | | [aria](aria/SKILL.md) | Accessibility patterns — ARIA, keyboard, focus, media player a11y | Yes | +| [claude-update](claude-update/SKILL.md) | Update CLAUDE.md and skills when introducing new patterns | No | +| [component](component/SKILL.md) | Build headless UI components — compound patterns, state, styling | Yes | +| [docs](docs/SKILL.md) | Write Video.js 10 documentation | Yes | | [git](git/SKILL.md) | Git workflow — commit messages, PRs, branch naming, scope inference | No | +| [rfc](rfc/SKILL.md) | Write RFCs — design docs, architecture proposals, component specs | No | ## Review Workflows @@ -98,4 +100,4 @@ When code changes introduce new patterns that a skill should cover: - New API design decisions (extensibility, type safety) - New DX considerations (inference, defaults, naming) -**After modifying skills:** See CLAUDE.md "Keep AI Documentation Current" for consistency checklist. +For detailed guidance and consistency checklists, run `/claude-update`. diff --git a/.claude/skills/claude-update/SKILL.md b/.claude/skills/claude-update/SKILL.md new file mode 100644 index 00000000..fc97f3cc --- /dev/null +++ b/.claude/skills/claude-update/SKILL.md @@ -0,0 +1,45 @@ +--- +name: claude-update +description: Update CLAUDE.md and skills when introducing new patterns or conventions +context: fork +disable-model-invocation: true +agent: general-purpose +--- + +# Claude Update + +Review any feedback, preferences, suggestions or rules that the user provided during task and +update AI documentation to incorporate them as appropriate. + +## When to Update + +- New naming conventions or code patterns +- New anti-patterns discovered during implementation +- Changes to component architecture, accessibility, or API design +- New utilities or shared patterns + +## Where to Put It + +| Type | Location | +| ----------------------------- | -------------------- | +| Cross-cutting (naming, utils) | CLAUDE.md Code Rules | +| Component patterns | `component` skill | +| Accessibility | `aria` skill | +| API design / DX | `api` skill | +| Documentation | `docs` skill | + +**Decision:** Ask "Who needs this?" — if domain-specific, use a skill. + +## After Modifying Skills + +Check consistency: + +1. `.claude/skills/README.md` — Quick Reference, Skills table +2. `CLAUDE.md` — if skill changes affect repo-wide conventions + +## Process + +1. Identify what changed (pattern, convention, anti-pattern) +2. Route to correct location (table above) +3. Make the update +4. Run consistency checks (if modifying skills) diff --git a/CLAUDE.md b/CLAUDE.md index 6434f8f8..11261702 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -102,9 +102,7 @@ pnpm clean 5. Lint file/s, fix all issues. 6. Run build/s, fix all errors. 7. Before creating a PR `pnpm test`. -8. If your changes introduced new patterns or conventions, review meta-documentation: - - **CLAUDE.md** — New naming conventions, code rules, or anti-patterns. - - **Skills** — New component patterns, API design patterns, or DX considerations. +8. If your changes introduced new patterns or conventions, ask the user to run `/claude-update`. Be efficient when running operations, see "Common Root Commands". @@ -180,14 +178,7 @@ When generating or editing code in this repository, follow these rules to ensure - One focused change per commit—no mixed updates. - Breaking changes use `!`. -7. **Keep AI Documentation Current** - - When introducing new naming conventions or code patterns, update the Code Rules section. - - When changes affect component architecture, accessibility, or API design, update relevant skills in `.claude/skills/`. - - When discovering anti-patterns during implementation, document them to prevent recurrence. - - **After modifying skills**, check for consistency: - 1. `.claude/commands/*.md` — update if they reference changed skills or paths - 2. `.claude/skills/README.md` — update Quick Reference, Skills table, Review Workflows - 3. This file (CLAUDE.md) — update if skill changes affect repo-wide conventions +7. **Keep AI Documentation Current** — When introducing new patterns, ask the user to run `/claude-update` for guidance. ## Code Rules @@ -499,5 +490,6 @@ CLAUDE.md contains repo-wide conventions. Domain-specific patterns live in skill | Accessibility | `aria` skill | | Documentation | `docs` skill | | API design and DX | `api` skill | +| Updating AI docs | `claude-update` skill | When adding a new rule, ask: "Who needs this?" If it's domain-specific, put it in the relevant skill.