Repository navigation
Auto Documentation & Docstrings Action
A GitHub Action that automatically generates comprehensive documentation and docstrings for multi-language codebases using AI models (Anthropic Claude or Google Gemini).
🚀 Features
- Multi-language Support: Works with Go, TypeScript, and Python
- AI-Powered: Uses either Anthropic Claude or Google Gemini for intelligent documentation generation
- Automatic Detection: Scans your codebase and identifies files that need documentation
- Smart Documentation: Generates appropriate docstrings following language-specific conventions
- Repository Analysis: Creates an AI_CONTEXT.md file with comprehensive project context
- Pull Request Workflow: Creates a new branch with documentation changes for review
🎯 Supported Languages
| Language | Documentation Style | Features |
|---|---|---|
| Go | // FunctionName does... |
Exported functions, parameters, return values |
| TypeScript | /** @description */ TSDoc |
Functions, classes, interfaces with JSDoc tags |
| Python | """Triple quotes""" |
Functions and classes with Google/NumPy style |
Full Changelog: https://github.com/Devasy23/auto-documentation-action/commits/v1.0.0