Integrations and WorkflowsGitHub Integration
Integrations and Workflows

GitHub Integration

Connect the Documentation.AI GitHub App and add context repositories so the AI agent can use your code and commits while working on docs.

Overview

Use the GitHub integration to connect the Documentation.AI GitHub App and link specific repositories as context for a documentation project. This lets the AI agent read code files and recent commits while planning and editing your docs.

Context repositories are GitHub repositories linked to your documentation. The AI agent can reference code files and recent commits from these repositories to generate more accurate plans, execute tasks, and keep documentation aligned with your code.

For syncing and publishing your docs from a Git repository (for example, building from main), see the Code Editor page. The context repository feature described here is separate and focuses on read-only context for the AI agent.

Before you start

Make sure you have the right access so you can install the app once and then connect repositories to your projects without interruptions.

You need:

  • An organization or workspace admin role in Documentation.AI

  • Permission in GitHub to install apps and grant repository access

  • At least one documentation project created in your Documentation.AI workspace

1. Install and manage the GitHub App

Install the Documentation.AI GitHub App once at the organization level, then reuse that connection across all of your documentation projects.

Open the GitHub App settings

In the Documentation.AI dashboard, go to Settings → Organization Settings → GitHub App. This page shows the current connection status and provides the link to install or manage the app on GitHub.

Install the Documentation.AI GitHub App

On the GitHub App page, click Install GitHub App or Manage installation. You will be redirected to GitHub to complete the app installation.

  • Choose the GitHub organization or user account.

  • Select the repositories the app can access (recommended: only the repos you plan to use as context or for docs).

  • Confirm the installation.

After a successful install, the GitHub App section in Organization Settings shows the connected GitHub account as active.

Verify the connection

Return to Settings → Organization Settings → GitHub App in Documentation.AI. You should see your GitHub organization or user listed as connected with an active status.

If the connection shows as missing or inactive, click the installation link on this page again to repair it from GitHub.

Installing the GitHub App connects your GitHub account to Documentation.AI at the organization level. You still need to select context repositories per documentation project to give the AI agent specific codebases to reference.

2. Add context repositories for a documentation site

After the GitHub App is installed and active, connect one or more context repositories to each documentation project that should use code-aware AI.

Open the GitHub integration for your project

In the Documentation.AI dashboard, open the documentation project you want to configure. Go to Settings → Integrations, find the GitHub integration, and click Configure.

The GitHub integration page for this project opens.

Add your first context repository

Once the context repository manager is visible, click Add repository, then:

  • Select one of the repositories that the Documentation.AI GitHub App can access.

  • Confirm to add it as a context repository for this documentation project.

On success, the repository appears in the list of connected context repositories for this project.

Manage connected context repositories

Use the GitHub integration page to review and manage the repositories linked to this documentation project.

You can:

  • See which repositories are currently connected as context

  • Remove a repository if it is no longer relevant

  • Add another repository (up to the allowed limit) using Add repository

Changes here take effect immediately for the AI agent when it plans or edits documentation in this project.

Context repository limits

Each documentation project can have up to 2 context repositories connected at a time. This limit currently applies to all plans. When you need more than 2 repositories, Contact sales to discuss higher limits.

The 2-repository limit applies per documentation project. You can use different repositories for different projects, as long as each individual project does not exceed two context repositories.

Troubleshooting

Use these quick checks if the GitHub integration or context repositories are not behaving as expected.