DocAI
Developer Docs
Everything you need to get started, integrate, and build on top of DocAI.
Getting Started
Sign in with GitHub, paste your first code snippet, and generate documentation in under 60 seconds.
GitHub Action
Auto-generate docs on every pull request. Set up once, forget about it forever.
REST API
Call DocAI from your own scripts, CI pipelines, or IDE plugins using our REST API.
Integrations
Connect DocAI with GitHub, Notion, Confluence, VS Code, and your CI/CD pipeline.
Quick start
From zero to your first generated doc in under 2 minutes.
Sign in with GitHub
Click 'Get started' and authenticate with your GitHub account. No other setup required — we use your GitHub identity.
Paste your code
Go to your dashboard, paste any function, file, or module into the code editor on the left pane.
Select a language
Pick your language from the dropdown (TypeScript, Python, PHP, Go, and 17+ more).
Choose a doc type
Pick Full Docs (recommended for most cases), README, API Reference, or Inline Comments.
Generate
Click Generate or press ⌘+Enter. Your documentation appears on the right in seconds.
Export
Copy to clipboard, download as a .md file, or use the API to push docs anywhere.
Doc types
Four types of documentation, each optimised for a different purpose.
fullFull Docs
Generates README + API Reference + Inline Comments in one shot. Counts as one generation.
readmeREADME
A complete README.md with project overview, installation steps, usage examples, and badges.
apiAPI Reference
Documents every function, parameter, return type, and includes real code examples.
inlineInline
Returns your code annotated with JSDoc, docstrings, or the language's native comment format.
Supported languages
20+ languages with native comment style and type annotation support.