Skip to content
DocuBot documentation

Key concepts

DocuBot turns your GitHub repositories into structured, static help centers. To manage your documentation effectively, you should understand these four foundational building blocks of the platform.

Documentation sites

A documentation site is the top-level container for your product’s help center. It acts as the public home for your content, accessible through a unique URL slug (such as docubot.cc/your-product).

Unlike standard documentation tools that often link to a single repository, a DocuBot site can aggregate content from multiple sources. This allows you to present a unified experience to your users even if your product’s code is spread across different repositories.

Example: You can create one “Finance Suite” documentation site that pulls information from your web dashboard repository, your mobile app repository, and your backend API repository simultaneously.

Audience-driven presets

DocuBot uses target audiences to automatically organize and prioritize your content. When you define who your readers are—such as End Users, Power Users, Administrators, or Developers—the system applies a preset that selects the most relevant document types for those groups.

While these presets provide a professional baseline, you can always refine the list by adding or removing specific document types to fit your project’s unique needs.

Example: If you select the “Developer” audience, DocuBot automatically includes API References and Authentication Guides. If you select “End User,” the system prioritizes Quick Start guides and core workflow tutorials.

Documentation styles

General styles act as a global overlay for your entire site. They control the voice, tone, and structural rules of every generated page. By selecting a style, you ensure that your documentation feels cohesive and professional, regardless of which team member wrote the code or which repository the data comes from.

Example: Choosing the “Precision Technical” style ensures your documentation uses exact terminology and structured tables for all settings. Switching to “Approachable Guided” transforms that same information into warmer, simpler language designed for non-technical readers.

Automated synchronization

Synchronization is the engine that keeps your documentation aligned with your latest code. Instead of manually updating help articles every time you ship a feature, you can set an automated schedule. DocuBot connects to your GitHub repositories and refreshes the content based on your preferred frequency—daily, weekly, or monthly.

Example: You can schedule a daily sync for 3:00 AM in your local time zone. Every morning, your documentation site automatically reflects the latest changes pushed to your GitHub branches the previous day.

Support and assistance

If you have questions about these concepts or need help configuring your workspace, you can reach out through the following channels: