sync-docs

Regenerate and verify TypeDoc documentation across packages after code changes.

207|39|Updated Aug 29, 2017
One-click install
npx skills add https://github.com/MichealWayne/fe-tools --skill sync-docs-michealwayne
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: sync-docs
Source: https://github.com/MichealWayne/fe-tools/tree/main/utils/skills/sync-docs
Command: npx skills add https://github.com/MichealWayne/fe-tools --skill sync-docs-michealwayne

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Regenerate or verify documentation to ensure API references stay accurate and aligned with code changes, saving time on manual updates.

Core Features & Use Cases

  • Regenerates TypeDoc output from source code for all packages.
  • Verifies documentation alignment across packages and flags mismatches for quick fixes.
  • Use case: after code changes, refresh the docs site to reflect the latest APIs and examples.

Quick Start

Execute the docs workflow to regenerate TypeDoc output for all packages.

Frequently Asked Questions about sync-docs

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

FAQPage Schema
How do I regenerate TypeDoc output after making code changes?

Regenerate TypeDoc output by executing the configured npm run docs workflow, which reads TypeScript sources and produces updated API reference documentation across all packages.

What's the best way to verify documentation alignment across multiple packages?

Verify documentation alignment by running the docs verification workflow, which checks all packages and flags mismatches between the source code and the generated reference docs for quick fixes.

Does documentation regeneration require TypeScript sources in specific directories?

Yes, documentation regeneration requires TypeScript source files to exist in packages/*/src and the npm run docs command to be configured to produce the expected TypeDoc output.

Why should I verify docs after updating code in my repository?

Verify docs after code updates to ensure API references and guides stay accurate and aligned with the latest changes, saving time on manual updates and preventing documentation drift.

Can I use this to generate API references for all packages at once?

Yes, the docs workflow regenerates TypeDoc output from source code for all packages in the repository simultaneously, refreshing the entire docs site to reflect the latest APIs and examples.