docs-generator

Generate date-stamped Markdown documentation from React codebases with Mermaid diagrams.

15|7|Updated Sep 11, 2023
One-click install
npx skills add https://github.com/huseyindeniz/vite-react-dapp-template --skill docs-generator
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-generator
Source: https://github.com/huseyindeniz/vite-react-dapp-template/tree/main/.claude/skills/docs-generator
Command: npx skills add https://github.com/huseyindeniz/vite-react-dapp-template --skill docs-generator

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

Maintaining accurate and comprehensive project documentation is a constant challenge, especially in rapidly evolving codebases. Manual documentation quickly becomes outdated, leading to confusion and increased onboarding time for new developers. This skill eliminates that burden by automatically generating detailed documentation directly from your source code.

Core Features & Use Cases

  • Automated Codebase Analysis: Intelligently scans your project's architecture, feature structures, state management patterns, and component organization to extract critical information.
  • Rich Markdown Documentation: Produces a structured set of Markdown files covering high-level architecture, individual feature details, design patterns, and practical guides, ensuring all aspects of your project are well-documented.
  • Visual Architecture Diagrams: Automatically creates Mermaid (or PlantUML) diagrams to visually represent complex architectural concepts, data flows, and feature dependencies, making the codebase easier to understand at a glance.
  • Use Case: After a significant refactoring or when preparing for a new team member's onboarding, simply activate docs-generator. It will analyze your entire project and output a complete, up-to-date documentation suite, saving countless hours of manual writing and ensuring everyone has a clear understanding of the codebase.

Quick Start

Use the docs-generator skill to analyze the current project and generate a full set of documentation, including architecture overviews and feature guides.

Frequently Asked Questions about docs-generator

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

FAQPage Schema
How do I generate documentation automatically from my codebase?

Generate documentation automatically by scanning your project's architecture, features, state management, and components to produce structured Markdown files and Mermaid diagrams. The docs-generator analyzes your codebase and outputs comprehensive documentation with date-stamped folders, eliminating manual writing and keeping docs in sync with code changes.

Can I use docs-generator with Redux Toolkit and Redux Saga projects?

Yes, docs-generator is designed for React projects using Redux Toolkit, Redux Saga, and dependency injection patterns. It analyzes per-feature state management, component architecture, and design patterns specific to this stack, generating organized documentation that reflects your actual implementation.

What documentation output does docs-generator produce?

Docs-generator produces structured Markdown files covering architecture overviews, individual feature details, state management patterns, component organization, and design patterns, plus auto-generated Mermaid diagrams visualizing data flows and dependencies. Output is organized in date-stamped folders under docs/ with daily overwrites.

How do I fix documentation drift after major refactoring?

Run docs-generator after refactoring to regenerate accurate, up-to-date documentation directly from your refactored codebase. It re-analyzes all features, architecture, state management, and components, replacing outdated docs with current information and ensuring documentation stays aligned with code reality.

Do I need manual documentation if I use docs-generator?

Docs-generator eliminates the burden of manual documentation maintenance by automatically extracting and organizing information from your source code. Instead of manually writing and updating docs, you run the tool to generate comprehensive, structured documentation that reflects your current codebase.

What analysis does docs-generator perform on my project?

Docs-generator performs per-feature analysis of architecture, state management patterns, component structure, and design patterns using specialized analysis modules. It generates structured JSON metadata and visual diagrams, enabling incremental documentation generation organized by feature with complete architectural context.