Skip to content
DocuBot documentation

FAQ

Find answers to common questions about using DocuBot to generate, customize, and maintain your product documentation.

General questions

What is DocuBot

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

Why does DocuBot generate static sites

DocuBot uses Astro and Starlight to produce static HTML pages. This approach ensures your documentation is SEO-friendly, loads instantly for your users, and provides reliable, linkable routes that support teams can share with confidence.

Account and access

How do I sign in to the dashboard

You can access your DocuBot workspace by signing in with your Google account. Once authenticated, you can manage all your documentation projects from a single dashboard.

Why do I need to connect my GitHub account

While public repositories are accessible without additional steps, private repositories require GitHub OAuth authorization. Connecting your GitHub account allows DocuBot to securely retrieve your code for analysis and documentation generation.

Configuration and customization

What is a URL slug

A slug is the unique part of the web address that identifies your documentation site (e.g., docubot.cc/your-product-name). You define this slug when you create a new project to ensure your documentation lives at a clean, professional URL.

Can I choose who the documentation is written for

Yes. You can select from several target audiences, including End Users, Administrators, Power Users, and Developers. DocuBot uses these selections to pre-select the most relevant document types for your project.

What are documentation styles

Styles control the overall voice and tone of your help center. You can choose from options like:

  • DocuBot Default: Balanced and friendly for mixed audiences.
  • Precision Technical: Exact and scan-friendly for developers and admins.
  • Approachable Guided: Warm and supportive for non-technical users.

How do I exclude specific files from my docs

You can use “Ignore patterns” in your repository settings to exclude specific files or directories. This is useful for skipping large third-party libraries or internal assets that do not need to be documented.

Syncing and updates

How does my documentation stay updated

DocuBot keeps your documentation aligned with your code through scheduled syncs. You can configure your project to update on a Daily, Weekly, or Monthly frequency at a specific local time.

Can I trigger an update manually

Yes. If you have a paid account, you can use the “Rebuild documentation” feature in the dashboard to trigger an immediate sync. This ensures your latest code changes are reflected in the documentation without waiting for the next scheduled update.

API and technical reference

Does DocuBot support OpenAPI or Swagger

Yes. DocuBot automatically detects OpenAPI and Swagger specifications within your repositories. It renders these into interactive, modern API references using the Scalar viewer, which is integrated directly into your documentation site.

Support and contact

How do I get more help

If you have questions not covered in this FAQ or need technical assistance, you can reach out through the following channels:

For more detailed information on specific features, visit our Conceptual overview or Getting started guide.