Skip to content
DocuBot documentation

Hello world example

In this guide, we will create a live documentation site from a public GitHub repository. You will learn how to initialize a project, connect a source, and publish your first help center.

Prerequisites

Before we begin, ensure you have the following:

  • A Google account for signing in.
  • A URL for a public GitHub repository you wish to document.

Create your first documentation site

Follow these steps to generate your documentation.

  1. Sign in to the dashboard Navigate to the DocuBot landing page and click the Sign in button. Authenticate using your Google account to access your personal workspace.

  2. Initialize a new project Click the Add repository button on your overview page. In the Display name field, enter a name for your project. Notice that a unique URL slug is automatically suggested based on the name you provide.

  3. Connect a repository source Paste your GitHub repository URL into the GitHub repository URL field. DocuBot automatically validates the link and detects the repository’s primary role.

  4. Select the Developer audience Under the Audiences section, check the Developer box. You will see that a preset list of technical document types, such as API references and code examples, is automatically selected for you.

  5. Publish your documentation Click the Create documentation site button at the bottom of the form. DocuBot starts a sync job to analyze your code and build the static site.

Verification

Once the sync job completes, a live URL appears on your repository card (e.g., docubot.cc/your-slug). Click the link to view your newly generated, SEO-optimized documentation site.

Public API availability

A public API or developer SDK for programmatically managing documentation is not available in the current repository. All project management and documentation triggers must be performed through the DocuBot dashboard UI.

Support

If you encounter any issues during your first setup, contact our support team: