deep-wiki

What problem does it solve?

This skill helps you transform an unfamiliar or complex codebase into clear, navigable documentation so developers can understand architecture, modules, APIs, and workflows faster.

Core Features & Use Cases

• Architecture documentation: Produce an architecture overview with components, dependencies, and data-flow explanations using Mermaid diagrams.
• Module documentation: Create per-module pages covering purpose, public APIs, dependencies, and usage examples.
• API and guides documentation: Generate API references and getting-started/development/deployment guides so onboarding is smoother.
• Documentation structure planning: Standardize output into a consistent .docs/ directory structure to keep docs discoverable.

Quick Start

Use deep-wiki when you need to create documentation for a repository you are onboarding to, and instruct the assistant to generate an .docs/ folder layout with architecture, module, API reference, and guide pages that include Mermaid diagrams.