Crumb

An AI-powered documentation generator for code repositories with support for multiple programming languages and automated documentation generation. Built for CodeNection2025, this tool helps developers create comprehensive and maintainable documentation for their projects.

Reference:

Figma Prototype link: https://www.figma.com/design/fgRDXlFHY0aQfggnibb3Q5/Cookies?node-id=0-1&p=f&t=xyLwLTPqDXnWU2iz-0

Sample Documentation : https://docs.google.com/document/d/14PO0BOM7lGRSd34GyI7khoO1IvxBsRWEjynGMUNGO44/edit?usp=sharing

Documentation Generated by Crumb (prototype phase) : https://docs.google.com/document/d/1UV1nvOEEng8nQtt47wyqBDY6qdMNKvcZABMlK-Ku7yk/edit?usp=sharing

🌟 Features

• Multi-Language Support

  • Java
  • Python
  • JavaScript/TypeScript
  • Easily extensible for other languages

• Documentation Generation

  • AI-powered function documentation
  • Complete repository documentation
  • Individual file documentation
  • Class relationship diagrams

• Format Support

  • Markdown
  • Microsoft Word (DOCX)
  • High-quality diagrams (PNG)

• Code Analysis

  • Repository structure analysis
  • Architecture pattern detection
  • Function and class analysis
  • Git history integration

🛠️ Technology Stack

• Backend: FastAPI (Python)
• Documentation: OpenAI GPT API integration
• Diagram Generation: Mermaid CLI
• Version Control: Git integration
• File Processing: Python-docx, Pillow

📚 API Endpoints

Core Endpoints

• GET /: API health check and info
• GET /supported-languages: List supported programming languages
• GET /scan-repository: Analyze repository structure

Documentation Generation

• POST /generate-docs: Generate documentation for a single file
• POST /generate-complete-repo-docs: Generate complete repository documentation
• POST /generate-individual-docs: Generate separate documentation for each file
• POST /insert-diagram-to-docx: Generate and insert class diagrams

Document Conversion

• POST /convert-docs-to-word: Convert markdown to Word format
• POST /convert-single-file: Convert a single file to Word

🔄 Workflow

1. Repository Analysis

   • Scan repository structure
   • Detect programming languages
   • Analyze code architecture

2. Documentation Generation

   • Parse code files
   • Generate AI-powered documentation
   • Create relationship diagrams

3. Format Conversion

   • Convert to desired output format
   • Generate high-quality diagrams
   • Integrate with Word documents

🤝 Contributing

Feel free to submit issues, fork the repository, and create pull requests for any improvements.

---

Built with ❤️ for CodeNection2025