Skip to content
DocuBot documentation

Common integration how-to

DocuBot transforms your source code into a structured, static help center. By integrating your GitHub repositories, you ensure your documentation stays synchronized with every code change.

Prerequisites

Before you begin, ensure you have the following:

  • A DocuBot account (signed in via Google).
  • The URL of the GitHub repository you want to document.
  • An OpenAPI or Swagger specification file (JSON or YAML) located within your repository if you intend to generate API references.

1. Connect a public repository

The quickest way to start is by linking a public repository. Public repositories do not require additional GitHub authorization.

  1. Open your DocuBot workspace and click Add repository.
  2. Enter a Display name. This is the internal name used to identify the project in your dashboard.
  3. Enter the URL slug. This defines the public web address where your documentation will live (e.g., docubot.cc/your-product-name).
  4. Paste the GitHub repository URL into the source field.
  5. Click Create documentation site.

Expected result: The repository appears in your Tracked projects list, and DocuBot begins the initial scan to identify the codebase structure.

2. Authorize private repository access

To document private codebases, you must grant DocuBot permission to read your GitHub data through a secure OAuth connection.

  1. Navigate to Settings in the sidebar.
  2. Locate the GitHub connection section.
  3. Click Connect GitHub.
  4. Follow the prompts on the GitHub authorization screen to grant access.
  5. Once redirected, verify that your GitHub username appears as Connected.

Expected result: You can now add private repositories as sources using the same steps as public repositories.

DocuBot automatically detects API specifications to create interactive, high-performance reference pages.

  1. Ensure your repository contains a valid OpenAPI (3.0+) or Swagger (2.0) file.
  2. In the repository configuration, ensure the Developer audience is selected.
  3. Verify that the API reference document type is included in your selection.
  4. DocuBot will scan the repository, identify the specification, and render it using the built-in Scalar API viewer.

Expected result: An API reference entry appears in your documentation sidebar, providing an interactive environment for developers to explore your endpoints.

4. Configure the automated sync schedule

Keep your documentation aligned with your latest releases by setting a recurring update cadence.

  1. Go to Repositories and click Edit settings on your project.
  2. Locate the Update frequency section.
  3. Select your preferred cadence:
    • Daily: Updates every 24 hours at a specific time.
    • Weekly: Updates on a specific day of the week.
    • Monthly: Updates on a specific day of the month.
  4. Choose the Update time and confirm your Time zone.
  5. Click Save changes.

Expected result: DocuBot automatically triggers a documentation rebuild according to your schedule. You can monitor the status of these updates via the Last sync indicator on your project card.

Integration configuration example

When setting up your integration, your configuration typically follows this structure:

SettingExample Value
Display NameCloudSync Pro
URL Slugcloudsync-pro
Primary Sourcehttps://github.com/your-org/cloudsync-main
API Sourcehttps://github.com/your-org/cloudsync-api
Sync FrequencyDaily
Update Time03:00 AM

Verification and support

Once your integration is configured, visit your public URL slug to view the live documentation. If the site is still generating, you will see a “Syncing” status in your dashboard.

If you encounter issues connecting a repository or if your API specifications are not being detected, please reach out for assistance: