Skip to content
cccskills
FreePublished on GitHub

docs-sync

Audit the project's documentation (CLAUDE.md, .claude/rules, skills, README, CONTRIBUTING, SECURITY, .env.example, app/data/*.md, learn articles) against the actual code and config, and fix drift. Use after refactors, dependency or workflow changes, or on a schedule.

The English summary is being prepared. Showing the original description.

See how to install

Files included (1)

  • SKILL.md2.1 KB

SKILL.md (original)

Review the instructions the agent will receive before you install.

Docs ↔ code drift audit

Verify every factual claim against the source. Anything unverifiable or wrong gets fixed, or listed if --report-only was passed ($ARGUMENTS).

Checks

  1. Commands: every pnpm <script> mentioned in README.md, CONTRIBUTING.md, CLAUDE.md, .claude/**, and .github/** exists in package.json scripts.
  2. Files and paths: every path mentioned in docs exists (ls/Glob). Pay special attention to the architecture trees in README.md and CLAUDE.md.
  3. CI/workflows: descriptions of .github/workflows/*.yml (triggers, jobs, what runs) match the YAML.
  4. Env vars: .env.example lists exactly the variables read by nuxt.config.ts, server/, playwright.config.ts, and workflows, each with an accurate description.
  5. Product facts: palette, font, shade, and radius lists in app/data/*.md, content/learn/**, and server/utils/aiSystemPrompt.ts match shared/constants/theme.ts. AI model lists in docs match app/types/ai.ts.
  6. Dependencies: libraries named in docs (e.g. SECURITY.md's "DOMPurify", "Dependabot") are actually installed or configured and used.
  7. Claude setup: skills and agents named in CLAUDE.md and .claude/README.md exist; .claude/rules/* paths: globs match real files; hooks referenced in .claude/settings.json exist.
  8. Config hygiene: .prettierignore, .gitignore, the knip key in package.json, eslint.config.mjs, .github/labeler.yml, and .github/CODEOWNERS don't reference paths that no longer exist.

Output

A table of file:line | claim | reality | action. Fix what you can (docs only; if the code is wrong, report it rather than change behavior), run pnpm format, and summarize the fixes and open questions.

Reviews

No reviews yet. Tell others what you thought.

Comments

No login needed. Share how it worked for you, ask a question, or note where it did not run.

No comments yet. Be the first to write one.

Comments are published right away. Do not include personal information such as email addresses or phone numbers. Up to 2 URLs.

0 / 1,000 characters

This form is protected by reCAPTCHA, and the Google Privacy Policy and Terms of Service apply.

More skills from this repository

Add, update, or retire an AI provider model option for the BYOK theme generator (OpenAI, Anthropic, Google) and verify the provider requests native structured output for it. Use when model lists go stale or a new provider/model is requested.

The English summary is being prepared. Showing the original description.

mattycraig/nuxt-theme-builder9Updated Oct 19, 2026

Add a new interactive design tool under /tools (like the color converter or contrast checker) — component, page, navigation, route lists, SEO, and tests. Use when building a new utility tool.

The English summary is being prepared. Showing the original description.

mattycraig/nuxt-theme-builder9Updated Oct 19, 2026

Write and register a new Learning Hub article (Nuxt Content markdown under content/learn) with valid frontmatter, navigation entry, route list entry, and accurate product details. Use when adding or substantially rewriting a learn guide, reference, or tip.

The English summary is being prepared. Showing the original description.

mattycraig/nuxt-theme-builder9Updated Oct 19, 2026

Add a new component showcase, block, or template preview page and register it everywhere it must appear (navigation, command palette, route lists, SEO, source view). Use when adding anything under /components, /blocks, or /templates.

The English summary is being prepared. Showing the original description.

mattycraig/nuxt-theme-builder9Updated Oct 19, 2026

Checklist for adding or changing a field on ThemeConfig (a new design token, per-mode setting, or export option) end to end — schema, defaults, store + history, CSS apply, export, editor UI, AI, and tests. Use whenever ThemeConfig's shape changes.

The English summary is being prepared. Showing the original description.

mattycraig/nuxt-theme-builder9Updated Oct 19, 2026

Run the project's validation pipeline (lint → format → typecheck → unit tests) with auto-fixes, then optionally stage and write a Conventional Commit. Use before committing, when asked to "check", "validate", "run the workflow", or "get this commit-ready".

The English summary is being prepared. Showing the original description.

mattycraig/nuxt-theme-builder9Updated Oct 19, 2026

See all skills by mattycraig

Report a problem with this skill