doctai
AI-powered documentation testing
Stop wondering if your docs work—know for certain.
doctai automatically verifies your documentation by reading it with AI, generating test scripts, and executing them.
Overview
doctai solves a common problem: outdated or broken documentation. It uses AI to:
- Read your documentation (setup guides, tutorials, installation instructions)
- Understand what needs to be done through AI analysis
- Generate executable test scripts (bash, python, etc.)
- Execute those scripts to verify everything works
- Report results so you know if your docs are accurate
Perfect for:
- CI/CD pipelines (via GitHub Actions)
- Regular documentation validation
- Testing installation guides
- Verifying tutorials and examples
- Ensuring setup instructions work
Key Features
- Multiple AI Providers - OpenAI, Anthropic (Claude), Google Gemini, or custom endpoints
- Flexible Configuration - Config files or command-line arguments
- GitHub Actions - Automate testing in CI/CD pipelines
- Multiple Sources - Test files, directories, or remote URLs
- Smart Script Generation - AI creates executable test scripts
- Safe Execution - Isolated environments with timeouts
- Detailed Reporting - Clear results with execution logs
Quick Start
# 1. Install
pip install doctai
# 2. Create config
cat > .doctai.yml << 'EOF'
docs:
- README.md
- docs/installation.md
provider: openai
EOF
# 3. Run
doctai --api-key $OPENAI_API_KEY
See Get Started for detailed instructions.
Documentation
Getting Started
- Getting Started - Install and run your first test
- Installation - Detailed setup guide
Guides
- Configuration - Config file guide
- Custom Instructions - Guide AI behavior
- Gemini Setup - Use Google Gemini
- Features Overview - All features explained
Configuration
- API Key Configuration - Flexible API key setup
- Generated Scripts - Inspect generated test scripts
Reference
- Architecture - Technical design
- Contributing - Contribution guide
- Project Overview - Complete summary
Changelog
💡 Example Usage
Basic Usage
doctai --docs README.md --api-key $OPENAI_API_KEY
With Configuration File
# .doctai.yml
docs:
- README.md
- docs/installation.md
provider: gemini
model: gemini-1.5-pro-latest
instructions: |
- Test on Ubuntu 22.04
- Use Python 3.10+
- Skip Docker examples
doctai --api-key $GEMINI_API_KEY
In GitHub Actions
- name: Test Documentation
run: doctai --api-key $
🔗 Quick Links
🤝 Contributing
We welcome contributions! See our Contributing Guide for details.
📄 License
MIT License - see LICENSE for details.
Made with ❤️ for developers who care about documentation quality
Version 0.1.0