Skip to content
DocuBot documentation

Hello world example

This guide helps you achieve your first success with DocuBot by creating a live documentation site from a public GitHub repository in under five minutes.

Prerequisites

Before you begin, ensure you have the following:

  • A Google account for authentication.
  • A public GitHub repository URL (e.g., https://github.com/user/repo).

Create your first documentation site

Follow these steps to generate your first set of documentation.

  1. Sign in to the dashboard Navigate to the DocuBot workspace and select Sign in. Use your Google account to authenticate and access your personal workspace.

  2. Define your site identity Select Add repository or Create documentation site. Enter a Display name for your project and choose a unique URL slug. This slug determines your public documentation address (e.g., docubot.cc/your-slug).

  3. Connect your source code In the Repository sources section, paste the URL of your public GitHub repository. DocuBot automatically detects the repository role. You can leave this as “Auto detect” for your first project.

  4. Select your audience Choose at least one target audience, such as End User or Developer. This selection automatically populates a recommended list of document types, such as Quick Start Guides and API References.

  5. Publish the site Review your settings and select Create documentation site. The system enqueues an initial synchronization job to pull your code and generate the static HTML pages.

Verification

Once the synchronization status changes to Succeeded on your repository card, you can verify the result:

  1. Click the View docs button on the repository card.
  2. The system opens your new documentation site in a new tab.
  3. Confirm that the navigation sidebar contains the document types you selected.

Public API availability

A public API or SDK for programmatic integration with DocuBot is not available in the current repository. All documentation management and site generation must be performed through the DocuBot dashboard.

If you require assistance with custom integrations or have questions regarding API access, please contact our support team: