Skip to content
DocuBot documentation

FAQ

Find quick answers to common questions about setting up your workspace, managing repository synchronization, and customizing your documentation output.

General questions

What is DocuBot

DocuBot is an automated platform that transforms your GitHub repositories into structured, high-quality help centers. It uses AI to analyze your source code and generate static documentation that is optimized for search engines and technical accuracy.

How does the AI generation process work

The system analyzes your codebase to understand your product’s features, architecture, and workflows. It then applies a layered style model—combining your selected general style with specific document-type rules—to write content tailored for your chosen audiences.

Is the documentation static or dynamic

All documentation is generated as static HTML. This ensures high performance, reliability, and excellent SEO visibility for your help center.

Setup and repository management

Can I group multiple repositories together

Yes. DocuBot allows you to aggregate multiple GitHub repositories under a single product documentation site. This is ideal for products that span across different apps, APIs, and reference libraries.

How do I connect a private repository

To connect a private repository, you must authorize DocuBot via GitHub OAuth. This provides the system with the necessary permissions to read your code and generate documentation without exposing your source files to the public.

What is a URL slug

A URL 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 during the initial setup of your documentation site.

Syncing and updates

How often does my documentation update

You can configure an automated synchronization schedule based on your needs. DocuBot supports daily, weekly, and monthly sync frequencies at a specific local time of your choosing.

Can I trigger a manual update

Manual syncs are available for paid accounts. This allows you to rebuild and publish your documentation immediately after pushing significant changes to your repository.

What happens if there are no code changes

If the system detects that the latest commit matches the last synced version, it will skip the generation process to save resources while still recording the successful check in your dashboard.

Customizing documentation styles

What are General Styles

General Styles control the overall tone and structural rules of your documentation. You can choose from options like Precision Technical for developer-focused content or Approachable Guided for a warmer, onboarding-friendly experience.

How do audiences impact my documentation

When you select target audiences (such as End User, Administrator, or Developer), DocuBot automatically pre-selects a relevant set of document types. For example, selecting “Developer” will prioritize API references and quick-start guides.

What is Scenario Focus

Scenario Focus is an advanced input field where you can list specific user workflows you want the AI to prioritize. This ensures your “How-to” guides cover the tasks most important to your users.

API and developer reference

How are API references rendered

DocuBot automatically detects OpenAPI and Swagger specifications within your repositories. It renders these into a dedicated, interactive API viewer powered by Scalar, allowing developers to explore endpoints and payloads directly.

Does DocuBot support interactive documentation

Yes. The API reference section is fully interactive, providing a modern interface for developers to test and understand your public interfaces.

Support and account management

What are the limits for free accounts

Free accounts are limited to tracking one repository and are restricted to a monthly synchronization schedule. Manual syncs and more frequent updates require a paid subscription.

How do I get help

If you encounter issues or have questions not covered here, you can reach out to our support team through the following channels:

How do I delete my account

You can manage your account and data through the Profile section in your dashboard. Deleting your account will remove all tracked repositories, generated documentation, and stored integration tokens.