Skip to content
DocuBot documentation

Initial configuration guide

You can generate and publish a professional documentation site in just a few minutes. This guide walks you through the essential configuration steps to connect your code and launch your help center.

How to configure your first documentation site

Follow these steps to establish your workspace and prepare your first documentation sync.

  1. Create a documentation project Open your workspace overview and click the Add repository button. Provide a friendly display name for the project. This name is used for internal tracking within your dashboard.

  2. Reserve your public URL slug Enter a unique identifier in the URL slug field. This defines the permanent web address where your documentation is hosted (for example, docubot.cc/your-slug). You can verify the live address using the preview link shown below the input field.

  3. Connect GitHub repository sources Paste your GitHub repository URL into the source input. If you need to access private repositories, click the Connect GitHub button to authorize access. You can assign specific roles to each source, such as Primary UI for your main application or API Reference for technical specs.

  4. Define target audiences and document types Select the audiences you intend to serve, such as End User or Developer. DocuBot automatically recommends a preset of document types based on your selection. You can manually toggle specific pages, like a Quick start guide or API reference, using the checklist.

  5. Select a documentation style Choose the voice and tone for your help center in the style gallery. You can select DocuBot Default for a balanced tone, Precision Technical for exact specifications, or Approachable Guided for a warmer, step-by-step feel.

  6. Configure the synchronization schedule Set an update frequency—such as Daily, Weekly, or Monthly—to keep your docs aligned with code changes. Choose a specific Update time based on your preferred time zone to automate the generation process.

Core settings checklist

Verify these critical configurations before you trigger your first synchronization:

  • Unique URL slug is defined and reserved.
  • GitHub repository is validated and connected.
  • At least one target audience is selected.
  • A recurring sync frequency is established.

Get help

If you encounter issues during setup or need help with repository limits, contact our support team: