litho-document-skill

Generates C4 architecture documentation from any codebase through agent-driven analysis.

1.7k|190|Updated Sep 5, 2025
One-click install
npx skills add https://github.com/sopaco/deepwiki-rs --skill litho-document-skill
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: litho-document-skill
Source: https://github.com/sopaco/deepwiki-rs/tree/main/.agents/skills/litho-documents-skill
Command: npx skills add https://github.com/sopaco/deepwiki-rs --skill litho-document-skill

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Manually writing and maintaining architecture documentation is time-consuming and quickly drifts out of sync with the actual code. This Skill lets an AI agent autonomously analyze any codebase and produce a complete set of C4 model documentation—overview, architecture, workflows, module deep-dives, boundary interfaces, and database overview—without requiring any external binary.

Core Features & Use Cases

  • Four-Phase Documentation Pipeline: Preprocessing (project scanning), Research (C1-C4 multi-level analysis), Composition (Markdown generation), and Output (validation and delivery), mirroring the deepwiki-rs workflow.
  • Full Module Coverage with DDD Grouping: Identifies every domain module under the source tree, classifies them as core/supporting/generic domains, and generates a dedicated Deep-Exploration document per module with Mermaid diagrams.
  • Context-Safe Intermediate Persistence: Writes research findings to a .litho-agent/ temporary directory so long analysis sessions never lose earlier results.
  • Use Case: Point the agent at an unfamiliar repository and ask it to document the project; it will produce 1.概述.md through 6.数据库概览.md with C4 context/container diagrams, sequence diagrams, ER diagrams, and confidence scores.

Quick Start

Ask the agent to analyze this codebase and generate complete C4 architecture documentation in the output directory.

Frequently Asked Questions about litho-document-skill

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

FAQPage Schema
How do I generate architecture documentation for a codebase automatically?

Invoke this Skill with a request to document the repository. The agent scans the project structure, researches system context and domain modules, then writes C4 context, container, and component diagrams plus workflow and interface documents as Markdown files.

What documents does the C4 documentation pipeline produce?

It produces six outputs: project overview, architecture document, workflow document, a Deep-Exploration folder with one file per domain module, boundary interfaces, and a conditional database overview with ER diagrams when SQL files or ORM dependencies are detected.

Does this Skill require the deepwiki-rs binary to be installed?

No. It is a pure agent-side parallel implementation of deepwiki-rs that relies entirely on the agent's own tools such as file reading, grep search, and semantic codebase search, with no external binary dependency.

Can it handle large codebases with hundreds of source files?

Yes. It adapts scanning strategy by project size: full reads for small projects, outline views and targeted searches for large ones. Research findings are persisted to a .litho-agent/ directory so long sessions do not lose earlier analysis.

When is the database overview document generated?

It is generated when the project contains .sql files, migrations or db directories, ORM dependencies like sqlx or prisma, or database configuration files. Otherwise a minimal declaration file is written stating no database was detected.

What are the limitations of agent-generated architecture documentation?

Analysis quality depends on how much code the agent actually reads, so low-importance modules receive only brief coverage. Each document includes a confidence score from 1 to 10 and a list of items needing human review.