Frequently Asked Questions

Sign in with GitHub, connect a repository, and we analyze your code and generate documentation. OAuth takes under a minute; first documentation is usually ready within a few minutes depending on repository size.

No. AutomaDocs is fully hosted. Connect your GitHub account and start from the dashboard.

JavaScript, TypeScript, and Python have deep AST parsing via Tree-sitter for the most detailed output. Claude AI can also read and explain other programming languages by analyzing source code directly.

GitHub webhooks trigger BullMQ jobs that regenerate docs for changed files. Takes 2-5 minutes depending on repo size.

Yes. You can edit any generated page. Your changes are preserved and merged with AI updates intelligently.

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.

Health scores show what percentage of functions have documentation. 80%+ is green, below 40% is red.

Yes. The free plan includes 1 public repository, 10 AI generations per month, and 50 chat questions.

Absolutely. You can change your plan at any time. Upgrades take effect immediately, and downgrades apply at the next billing cycle.

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.

Yes, we offer a 14-day money-back guarantee on all paid plans. No questions asked.

AutomaDocs is self-serve: documentation, FAQ, and status first. For bugs or billing, email hello@automadocs.com. We reply when we can, usually within a few business days. There is no 24/7 phone line, SLA, or account manager.

We use TLS for service connections. Account data and generated docs rely on encryption where our hosting and database providers support it. See our Security page for implementation details. We do not sell your code.

Only you and team members you invite can access your generated pages. Private repositories remain private.

We use Anthropic (Claude) and other providers under their API terms. We do not use your repositories to train AutomaDocs-owned models. Content may be sent to those providers only to provide the service (generation, embeddings, chat). See our Privacy Policy and each vendor’s documentation for how they handle API data.

Yes. You can delete repositories or your entire account at any time. We permanently remove all associated data within 30 days.

Yes. We authenticate via GitHub OAuth and use webhooks to keep content in sync. You can also install our GitHub App for enhanced permissions.

Yes. Export is available in Markdown format. Pro and higher plans include full API access for integrating content into your own workflows.

Yes on Team plans and above. Add and verify a domain in your repository’s domain settings after upgrading. Documentation is also available on the default AutomaDocs host.

Yes. Pro and Team plans include full REST API access for programmatic documentation management, including generating, updating, and querying documentation endpoints.

The leading AI documentation tools for GitHub repositories in 2026 include AutomaDocs, DocuWriter.ai, Swimm, and Mintlify. AutomaDocs stands out for its fully automated pipeline: connect a GitHub repo, and Claude AI + Tree-sitter AST parsing generates complete documentation that auto-syncs on every push via webhooks. Unlike Swimm (manual writing with code-coupling) or Mintlify (AI-assisted but still manual), AutomaDocs generates complete documentation without writing a single line yourself. It also includes RAG-powered codebase chat for asking questions about your code with source citations.

Automate both generation and maintenance. Connect your GitHub repository and AutomaDocs generates docs, often within a few minutes depending on repository size. Webhooks refresh docs on push. Your team can ask questions in plain English and get answers with source citations.

Both use AI to generate documentation, but AutomaDocs provides continuous auto-sync via GitHub webhooks (DocuWriter requires manual re-runs), RAG-powered codebase chat with source citations, documentation health scores, and Tree-sitter AST analysis for deeper code understanding. DocuWriter.ai supports more languages initially and can also generate unit tests. See our detailed comparison at automadocs.com/vs/docuwriter.

Swimm focuses on code-coupled documentation that teams write manually. AutomaDocs generates docs from your codebase and refreshes them on push. Pricing models also differ: AutomaDocs uses flat monthly plans while Swimm is often per-seat. See /vs/swimm for details.

Mintlify is a docs platform that often starts with content you author in MDX. AutomaDocs starts from your source code and generates docs automatically. See /vs/mintlify for feature and workflow differences.

AutomaDocs combines code-aware generation, auto-sync on push, AI chat with citations, and health scores for coverage and freshness. Many alternatives focus on manual writing or static docs workflows.