component-docs-batcher

What problem does it solve?

Monorepo component libraries often struggle to keep documentation in sync with code across many components. This skill automates discovering components, flagging missing or outdated docs, and generating structured tasks and Markdown docs for all components.

Core Features & Use Cases

• Intelligent component discovery: identifies the main component file (e.g., button/button.tsx) and ignores helper files (index.ts, store.ts, hooks).
• Git-time based freshness: uses git commit timestamps to determine if a doc is outdated.
• Todo and doc generation: creates a todos.md and ready-to-use index.zh-CN.md style docs.
• Monorepo documentation workflow: scales across many components and multiple directories.

Quick Start

Run the component-docs-batcher to scan a components directory, generate a todos.md, and create/update docs:

• npx ts-node .claude/skills/component-docs-batcher/scripts/scan-components.ts /path/to/components
• npx ts-node .claude/skills/component-docs-batcher/scripts/generate-todos.ts /path/to/components
• npx ts-node .claude/skills/component-docs-batcher/scripts/analyze-component.ts /path/to/Component.tsx
• npx ts-node .claude/skills/component-docs-batcher/scripts/scan-components.ts /path/to/components