Skip to content
DocuBot documentation

Getting started guide

DocuBot is an AI-powered platform that transforms your GitHub repositories into structured, static, and SEO-friendly documentation sites. It analyzes your source code to generate help centers tailored to your specific audiences and preferred documentation styles.

By following this guide, you will establish your workspace, connect your source code, and publish your first live documentation site.

Sign in to your workspace

The first step is to establish your user account and access the management dashboard.

  1. Navigate to the DocuBot dashboard.
  2. Click the Google Sign-In button.
  3. Authenticate with your preferred Google account to enter your new workspace.

Create your documentation project

Every documentation site needs a unique identity and a public URL where your users can find it.

  1. Click Create documentation site from the overview screen.
  2. Enter a Display name for your project. This is the internal name used to identify the project in your dashboard.
  3. Configure your URL slug. This determines your public documentation path, such as docubot.cc/your-slug.
  4. Notice the live preview of your URL as you type to ensure it meets your needs.

Connect your GitHub repositories

DocuBot analyzes your code to understand your product. You can link one or multiple repositories to a single documentation project.

  1. Enter the GitHub repository URL for your source code.
  2. If your repository is private, click Connect GitHub to authorize access via OAuth.
  3. Review the detected Role for each repository (such as Primary UI or API Reference). You can manually override these roles if you want to change how the AI prioritizes the context from that specific repo.

Define your audience and document types

Tailor your content by choosing who the documentation is for and which specific pages you want to publish.

  1. Select your target Audiences, such as End User, Administrator, or Developer.
  2. Review the Document types that DocuBot automatically preselects based on your audiences.
  3. Add or remove specific document types, like Quick Start Guides or API References, to customize your documentation set.

Select a documentation style

The documentation style determines the voice, tone, and formatting rules for your published site.

  1. Choose a General style from the available options:
    • DocuBot Default: Balanced and friendly for mixed audiences.
    • Precision Technical: Exact and scan-friendly for technical teams.
    • Approachable Guided: Warm and supportive for new or non-technical readers.
  2. Notice the summary and tone descriptions to find the best fit for your brand.

Configure your sync schedule

Automate your documentation updates to ensure your help center stays aligned with your latest code changes.

  1. Select an Update frequency, such as Daily, Weekly, or Monthly.
  2. Set a Local time for the sync to run.
  3. Verify that the Time zone matches your preferred location in your settings.

Publish and verify your documentation

Once your configuration is complete, you can trigger the initial generation and view your live site.

  1. Click Save changes or Create documentation site to initialize the project.
  2. Monitor the Sync job status on your repository card to watch the progress of the AI generation.
  3. Once the status shows “Up to date,” click the View docs link to visit your live documentation site.
  4. Verify that your content is accurate and formatted according to your selected style.

Get help

If you encounter issues during setup or have questions about your documentation project, contact support through the following channels: