deepwiki-rs

Litho (deepwiki-rs) is a high-performance documentation generator built in Rust designed to bridge the gap between evolving codebases and technical documentation. It acts as an autonomous agent that parses source code to create living documentation, specifically targeting the C4 architecture model (Context, Container, Component, Code). By automatically mapping module relationships and system design, it enables architects, technical leads, and developers to maintain accurate technical specs without the manual overhead of updating markdown files during development cycles.

• Automatically generates comprehensive C4 architecture diagrams and project overview documents.

• Supports multi-language codebases including Rust, Python, JavaScript, TypeScript, Go, Java, and C#.

• Integrates directly into CI/CD pipelines to ensure documentation remains synchronized with every git push or pull request.

• Provides intelligent codebase analysis, including extraction of structural logic, design decisions, and architectural evolution.

• Offers customizable documentation templates to fit specific team styles and professional standards.

• Supports external knowledge mounting for enhanced context, such as linking PDF, Markdown, or SQL database schemas to the code analysis.

• The tool is best invoked when you need to perform deep architectural analysis, generate onboarding materials for new team members, or prepare technical design specifications.

• Use the --model-efficient parameter for quick scans and --model-powerful for detailed C4 mapping in complex, large-scale monolithic or microservices projects.

• Input expected is a local path to the project root containing source directories like /src or /lib; output defaults to a organized ./litho.docs directory containing full markdown deep-dives.

• It is constrained by API rate limits depending on the selected AI model; users should utilize batch processing in large environments.

• Ideal for environments where manual documentation maintenance is a bottleneck or where architectural drift is a significant risk for the engineering team.