Frequently Asked Questions
Find answers to common questions about AutomaDocs, our AI-powered documentation platform.
Getting Started
How do I get started with AutomaDocs?
Simply sign in with your GitHub account, connect a repository, and we'll automatically analyze your code and generate documentation. The entire process takes about 60 seconds.
Do I need to install anything?
No installation required! AutomaDocs is a fully hosted web application. Just connect your GitHub account and you're ready to go.
What programming languages do you support?
We support all major languages including JavaScript, TypeScript, Python, Go, Rust, Java, C++, Ruby, PHP, and more. Our AI adapts to your codebase automatically.
Features
How does auto-sync work?
When you push code to GitHub, our webhooks automatically detect changes and regenerate affected documentation. Your docs stay in sync without any manual work.
Can I edit the generated documentation?
Yes! You can edit any generated documentation. Your changes are preserved and merged with AI updates intelligently.
What is the AI chat feature?
Our AI chat lets you ask questions about your codebase in plain English. It searches through your code and documentation to provide accurate answers with source references.
What are documentation health scores?
Health scores show how well-documented your codebase is, highlighting undocumented functions, missing API docs, and areas needing improvement.
Pricing & Plans
Is there a free plan?
Yes! Our free plan includes 3 repositories, 20 AI generations per month, and 50 chat questions. Perfect for personal projects.
Can I upgrade or downgrade anytime?
Absolutely. You can change your plan at any time. Upgrades take effect immediately, and downgrades apply at the next billing cycle.
What happens if I exceed my plan limits?
We'll notify you when you're close to your limits. If you exceed them, you can upgrade your plan or wait until the next billing cycle.
Do you offer refunds?
Yes, we offer a 14-day money-back guarantee on all paid plans. No questions asked.
Privacy & Security
Is my code safe?
Yes. Your code is encrypted in transit and at rest. We use industry-standard security practices and never share your code with third parties.
Who can see my documentation?
Only you and team members you invite can access your documentation. Private repositories remain private.
Do you train AI models on my code?
No. We use Claude AI for generation but do not train models on your code. Your code is only used to generate your documentation.
Can I delete my data?
Yes. You can delete repositories or your entire account at any time. We permanently remove all associated data within 30 days.
Integrations
Do you integrate with GitHub?
Yes! We authenticate via GitHub OAuth and use webhooks to keep docs in sync. You can also install our GitHub App for enhanced permissions.
Can I export my documentation?
Yes. You can export documentation as Markdown, PDF, or EPUB. Pro and higher plans support API access for custom integrations.
Do you support custom domains?
Custom domains are available on Team and Business plans. You can host your documentation at docs.yourcompany.com.