skills.rest
evanfang0054
evanfang0054COMMUNITY
Explore all skills by this author →
GitHub

component-docs-batcher

Scan monorepo component directories and generate structured Markdown documentation.

1|Updated Dec 11, 2025
Search Tags:#documentation#markdown#monorepo#batching#todos#git-timestamp
One-click install
npx skills add https://github.com/evanfang0054/cc-system-creator-scripts --skill component-docs-batcher
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: component-docs-batcher
Source: https://github.com/evanfang0054/cc-system-creator-scripts/tree/main/skills/component-docs-batcher
Command: npx skills add https://github.com/evanfang0054/cc-system-creator-scripts --skill component-docs-batcher

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

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

Frequently Asked Questions about component-docs-batcher

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

FAQPage Schema
How do I automate markdown documentation for a monorepo component library?▼

Automate monorepo component documentation by running scripts that scan component directories, detect missing index.zh-CN.md files, and batch generate structured Markdown docs and todos.

How does git timestamp based freshness detection work for outdated component docs?▼

Git timestamp freshness detection compares the last commit time of component source files against existing documentation to flag index.zh-CN.md files as outdated and generate update todos.

Can I batch generate documentation across multiple component directories in a monorepo?▼

Yes, batch documentation generation scans multiple monorepo component directories, identifies main component files while ignoring helpers like index.ts, and produces ready-to-use docs across all components.

What is the best way to enforce documentation standards in a monorepo component library?▼

Enforce documentation standards by validating export names against src/index.ts, extracting component metadata from source files, and generating structured Markdown docs that meet index.zh-CN.md requirements.

How do I identify which components in a monorepo are missing or have outdated documentation?▼

Identify missing or outdated documentation by scanning component directories, detecting absent index.zh-CN.md files, checking git commit timestamps for staleness, and outputting a consolidated todos.md task list.

Do I need to manually specify component files when generating monorepo documentation?▼

No, intelligent component discovery automatically identifies the main component file such as button/button.tsx while ignoring helper files like store.ts and hooks, requiring no manual specification.

Related Skills

Explore More Software Engineering Skills→
B0yZ4kr14B0yZ4kr14

speckit-repoindex-overview

Generate a structured Markdown repository overview from codebase layout and build files.

Community
Intermediate
u9401066u9401066
2

session-start

Recover Memory Bank context and generate a prioritized Todo List.

Community
Intermediate
zhangzhang-111-izhangzhang-111-i
2

changelog-generator

Generate changelog entries from Conventional Commits in markdown or JSON.

Community
Intermediate
joestumpjoestump
30

docs

Generate a Docusaurus documentation site from ADRs and OpenSpec specs.

Community
Advanced