documentation-sync

Updates project documentation alongside React code changes within the same pull request.

1|Updated Jun 9, 2026
One-click install
npx skills add https://github.com/VilnaCRM-Org/claude-plugins --skill documentation-sync-vilnacrm-org
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentation-sync
Source: https://github.com/VilnaCRM-Org/claude-plugins/tree/main/plugins/react-frontend-sdlc/skills/documentation-sync
Command: npx skills add https://github.com/VilnaCRM-Org/claude-plugins --skill documentation-sync-vilnacrm-org

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Code changes in a React/TypeScript frontend often ship without corresponding documentation updates, leaving READMEs, module docs, Storybook stories, and contributor guides stale and misleading. This Skill treats documentation as part of the definition of done, ensuring every code change lands with synchronized docs in the same branch and PR. ## Core Features & Use Cases - Documentation impact mapping: Maps each change type (components, hooks, GraphQL operations, state stores, configuration, security, testing, performance, accessibility) to the specific docs that must be updated. - Scenario-based update patterns: Provides concrete documentation patterns per scenario, including Storybook rebuilds, GraphQL mock fixture notes, DI wiring records, and Lighthouse budget references. - Quality gates and checklist: Enforces consistency, completeness, link validity, tested examples, and a pre-commit checklist integrated with Markdown lint and CI checks. - Use Case: After adding a new UI component with props and variants, use this Skill to update the module README, add a Storybook story, rebuild Storybook, and verify all examples and links before opening the PR. ## Quick Start Ask the assistant to update all affected documentation for the component and hook changes in the current branch before committing.

Frequently Asked Questions about documentation-sync

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I keep documentation in sync with code changes?▼

Identify which docs each code change affects using a documentation map, update the closest owning file in the same branch, validate all examples and links, and run the Markdown lint target before committing. Documentation ships in the same PR as the code.

What documentation should I update when changing a React component?▼

Update the closest owning module README with the component name, props, variants, and a usage example. Add or update the Storybook story, rebuild Storybook to confirm stories compile, and refresh any user-facing guide that references the component.

Does this skill work when Storybook is not configured?▼

Yes. When the Storybook capability is absent or its build target maps to null, the skill skips the Storybook rebuild step, notes that Storybook is unavailable, and documents the component example inline instead.

When should I not use the documentation-sync skill?▼

Do not use it to build an initial documentation suite from scratch; that belongs to the documentation-creation skill. It is designed for keeping existing docs synchronized with ongoing code changes, not greenfield documentation authoring.

How are testing thresholds documented without drifting from CI?▼

Thresholds come from profile quality keys such as coverage floors, the mutation MSI break value, and Lighthouse mobile and desktop budgets. Documented thresholds are raise-only, so docs never state a lower bar than CI enforces.