Integration guide

You can connect DocuBot to your GitHub repositories and OpenAPI specifications to automate the generation of your documentation. This guide walks you through authorizing access, linking your source code, and verifying that your documentation site is live.

Prerequisites and permissions

Before you begin the integration, ensure you have the following:

• Google account: Required to sign in to your DocuBot workspace.
• GitHub permissions: You must have read access to the repositories you intend to document.
• OpenAPI files: If you want to generate API references, ensure your repository contains valid Swagger or OpenAPI files (JSON or YAML).

Authorize GitHub access

To document private repositories or ensure stable connections to public ones, you must link your GitHub account to your workspace.

1. Open your DocuBot dashboard and navigate to Settings.
2. Locate the GitHub connection section.
3. Click Connect GitHub.
4. Follow the GitHub OAuth prompts to authorize DocuBot.
5. Verify that your GitHub username appears in your profile settings once the redirection is complete.

Connect a repository source

Once authorized, you can link specific repositories to your documentation site.

1. Navigate to the Repositories tab in your dashboard.
2. Click Add repository.
3. Enter the GitHub repository URL for your project.
4. Define a unique URL slug. This becomes the public web address for your documentation (e.g., docubot.cc/your-project).
5. Click Save to add the repository to your tracked projects list.

Configure repository roles

DocuBot uses roles to determine how to prioritize information during the AI generation process.

1. In the repository settings, locate your Repository sources.
2. Use the Role dropdown to assign a specific purpose to each linked repo:
   • Primary UI: The main application experience for your users.
   • UI app: Secondary experiences like admin consoles or mobile apps.
   • API reference*: Sources primarily used for API specifications.
   • Reference only: Supporting repositories without a user interface.
3. Save your changes to update the context budget for future syncs.

Set up OpenAPI ingestion

DocuBot automatically detects API specifications within your connected repositories to build interactive documentation.

1. Ensure your OpenAPI or Swagger files are committed to your repository.
2. DocuBot scans for these files during the synchronization process.
3. Once detected, an interactive API reference is rendered using the Scalar viewer.
4. Check your generated site’s sidebar to find the new API Reference links.

Verify the integration

After configuring your sources and roles, confirm that the connection is successful.

1. Return to the Repositories page.
2. Look for the Last sync status indicator on your repository card.
3. If the status shows Up to date, click View docs to open your live documentation site.
4. Confirm that the content aligns with your latest code and that all API references are accessible.

Troubleshooting connection issues

If you encounter errors during the integration process, check the following common resolutions:

• Private repository access: If a repository fails to sync, ensure your GitHub OAuth token is still valid. You can re-authenticate by clicking Connect GitHub in your settings again.
• Invalid URL slug: If your site is not accessible, verify that your slug contains only lowercase letters, numbers, and dashes.
• Missing API docs: If your API reference does not appear, confirm that your OpenAPI files use standard naming conventions (e.g., openapi.yaml or swagger.json) and are not located in ignored directories.

If you need further assistance, contact our support team at support@ademero.com, visit our support portal, or call us at 863-937-0272.

Next steps

Now that your repositories are connected, you can configure your sync schedule to keep your documentation updated automatically.