Keep your documentation perfectly aligned with your codebase by connecting your external Git providers. By linking your organization to platforms like GitHub or GitLab, you can automatically synchronize repositories, browse file trees, and pull file content directly into your workspace.
flowchart LR
A["Git Provider (e.g., GitHub)"] -->|"1. Authorize (OAuth)"| B["GitDocAI Workspace"]
B -->|"2. Trigger Sync"| A
A -->|"3. Fetch Trees & Content"| BConnecting a Git Provider
To start syncing your code, you first need to install the GitDocAI app on your Git provider and authorize access to your repositories.
- 1
Initiate the connection
Navigate to your organization's Settings and select Integrations. Click the Connect Git Provider button. This generates a secure installation URL specific to your organization.
- 2
Install the application
You will be redirected to your Git provider (such as GitHub). Choose the account or organization where your repositories live and approve the installation.
- 3
Authorize access
Once approved, the provider will redirect you back to GitDocAI. Our system handles the OAuth callback automatically, securely saving your new installation.
You can connect multiple Git providers or multiple accounts from the same provider. Each connection is managed as a separate "Installation" in your settings.
Managing Repositories
Once your Git provider is connected, GitDocAI can access the repositories you authorized.
Syncing Repository Data
While GitDocAI listens for changes, you can also manually trigger a synchronization to ensure your workspace reflects the absolute latest state of your external repository.
Go to the Repositories tab in your dashboard.
Locate the repository you want to update.
Click Sync Now.
During a sync, GitDocAI updates the following repository components:
| Component | Description |
|---|---|
| Metadata | Basic repository details like name, description, and default branch. |
| File Tree | The complete directory structure of your repository. |
| File Content | The actual text and code within your files, used to generate and update your documentation. |
Large repositories may take a few moments to fully synchronize. You can continue working in other areas of the app while the sync completes in the background.
Disconnecting a Provider
If you no longer need to sync documentation from a specific Git account, you can delete the installation.
Navigate to Settings > Integrations, find the active installation in your list, and click Remove.
Deleting an installation immediately revokes GitDocAI's access to those repositories. Any documentation currently relying on live-synced file content from that provider will no longer update until the provider is reconnected.
Frequently Asked Questions
Can I view the raw file content from my repository?
Yes! Once a repository is synced, you can browse its entire file tree and view the content of individual files directly within the GitDocAI interface.
What happens if I rename a repository on GitHub?
When you trigger a manual sync (or when the next automatic sync runs), GitDocAI will detect the updated repository metadata and update the name in your workspace automatically.
Developer Resources
If you are building custom workflows or integrating GitDocAI into your own internal tooling, you can manage Git synchronization directly via our API.