Home - auraz/autodoc_ai GitHub Wiki

Welcome to autodoc_ai 🚀

autodoc_ai is your all-in-one toolkit for automating commit message generation and enriching your README and Wiki documentation using AI. Designed for seamless integration into any development workflow, it helps you keep your project documentation and commit history clear, up-to-date, and high quality—with minimal effort.

✨ What Does It Do?

  • AI-Powered Commit Messages: Instantly generate meaningful, context-aware commit messages based on your code changes.
  • Automated README & Wiki Enrichment: Let AI suggest and append improvements to your README and Wiki articles, keeping docs fresh and relevant.
  • Effortless Integration: Works with your existing Makefile and git workflow—no need to change your habits.
  • Robust Testing & Linting: Includes helpers for code quality, formatting, and comprehensive test coverage.
  • Smart Diff Analysis: Only documents what's changed, making updates precise and concise.

🛠️ Key Features

  • One-Command Enrichment: Update your README and Wiki with a single command.
  • Customizable Prompts: Fine-tune how AI suggests documentation improvements.
  • Fallbacks & Error Handling: Gracefully handles missing API keys, empty diffs, or absent files.
  • Extensible: Easily add new documentation targets or AI enrichment strategies.
  • Modern Python: Built with best practices, type hints, and a clean, maintainable codebase.

🚦 Typical Workflow

graph TD;
    A[Code Changes] --> B[Stage with Git];
    B --> C[Run make cm or enrich command];
    C --> D[AI generates commit message];
    C --> E[AI suggests README/Wiki improvements];
    D --> F[Commit & Push];
    E --> G[Docs updated & staged];
    F --> H[Project & Docs Stay in Sync];
    G --> H;

📦 Quick Start

  1. Install the project and dependencies
  2. Configure your environment
  3. Use the provided Makefile commands to lint, test, format, and commit with AI assistance

📚 Documentation