Back to Help

Getting Started

Get up and running with DocuAI in just a few minutes.

1

Connect GitHub

First, sign in with your GitHub account. DocuAI uses GitHub OAuth to securely authenticate you.

  • Click "Start Free" on the homepage or go to /login.
  • Authorize DocuAI to access your GitHub account.
  • You'll be prompted to install the DocuAI GitHub App on your account or organization.
We only request the permissions needed to read repos and create pull requests.
2

Activate Repositories

Once connected, you'll see your repositories on the Dashboard. Toggle on the ones you want DocuAI to monitor.

  • Go to your Dashboard.
  • Find the repository you want to activate.
  • Click the toggle to enable DocuAI for that repo.
DocuAI will index your code and documentation to understand your project.
3

Relax and Ship Code

That's it! Now, every time you push code changes, DocuAI will analyze the impact on your documentation and create a Pull Request with suggested updates.

  • Push code to your repository as usual.
  • DocuAI detects changes and opens a PR with doc updates.
  • Review, edit if needed, and merge. Done!
You always have full control—DocuAI never merges without your approval.