Skip to content
DocuBot documentation

Integration guide

You can connect your GitHub account to DocuBot to generate documentation for private repositories. This integration allows DocuBot to securely read your code and keep your help center aligned with your latest restricted projects.

Prerequisites

Before you begin, ensure you have:

  • A DocuBot account.
  • A GitHub account with access to the repositories you want to document.

1. Navigate to workspace settings

Open your DocuBot dashboard and locate the primary sidebar. Click Settings to open your workspace preferences. This page contains your profile details, scheduling options, and integration management.

2. Initiate the GitHub connection

Scroll down to the GitHub connection section. You will see a status indicating that GitHub is not yet connected. Click the Connect GitHub button to start the secure authorization process.

3. Authorize repository access

DocuBot redirects you to the official GitHub authorization screen. Review the requested permissions, which allow DocuBot to read your repository content and metadata. Click Authorize Ademero Inc (or the DocuBot application) to grant access.

Once processed, GitHub automatically redirects you back to your DocuBot workspace.

4. Verify the connection status

Return to the Settings page in your dashboard. The GitHub connection section now displays a Connected status. You should also see your GitHub username listed, confirming that the integration is active and linked to the correct account.

5. Add a private repository

Now that your account is linked, you can add private projects to your workspace:

  1. Go to the Repositories page.
  2. Click Add repository.
  3. Paste the URL of your private GitHub repository.
  4. DocuBot validates the URL using your active integration and allows you to proceed with the documentation setup.

Troubleshooting and support

If you encounter issues during the authorization process or if your private repositories do not appear, try the following:

  • Ensure you are logged into the correct GitHub account in your browser.
  • Check that you have “Read” permissions for the specific repository you are trying to add.
  • If the connection fails, click Connect GitHub again to refresh the authorization token.

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

Next steps

Once your GitHub account is connected, you can configure your first repository and select the document types you want to publish.