Common integration how-to

You can integrate your GitHub repositories with DocuBot to transform your source code into structured, SEO-friendly help centers. This process automates the creation of documentation and ensures your content stays aligned with your latest code changes.

Authorize GitHub access

To access private repositories or ensure stable connections for public ones, you must first establish a secure link between DocuBot and your GitHub account.

1. Navigate to your workspace settings in the DocuBot dashboard.
2. Locate the GitHub connection section and click the button to connect your account.
3. Follow the GitHub OAuth prompts to authorize DocuBot.
4. Verify that your status displays as “Connected” once you return to the dashboard.

Expected result: Your GitHub account is linked, allowing DocuBot to scan and ingest your repository content.

Connect a repository source

Once authorized, you can add specific repositories as sources for your documentation project.

1. Select “Add repository” from your workspace navigation.
2. Enter the full GitHub URL for the repository you want to document.
3. Provide a display name and a unique URL slug for your public documentation site.
4. Assign a role to the repository, such as Primary UI or API Reference, to help the AI prioritize the most important parts of your code.

Expected result: The repository appears in your project source list, and DocuBot begins detecting the appropriate documentation types.

Configure synchronization triggers

Set up automated schedules to keep your documentation fresh without manual intervention.

1. Open the settings for your specific repository.
2. Choose an update frequency, such as daily, weekly, or monthly.
3. Select the local time and day you want the synchronization to occur.
4. Click “Save changes” to activate the schedule.

Expected result: A sync schedule is active. You can also trigger an immediate update at any time by clicking the “Rebuild documentation” button on your repository card.

Verify documentation publishing

Confirm that your integration is successfully generating and hosting your help center.

1. Navigate to your repository list.
2. Look for the “Up to date” status on your repository card.
3. Click the live URL link (e.g., docubot.cc/your-slug) to view your published site.
4. Check the “Exports” section if you need to download a bookmarked PDF version of your docs.

Expected result: Your documentation site is live, searchable, and accessible at your unique URL slug.

Get help with integrations

If you have trouble connecting your repositories or configuring your sync schedule, please reach out to our support team. You can contact us via email at support@ademero.com, visit our support portal at https://www.ademero.com, or call us at 863-937-0272.