Skip to content
DocuBot documentation

Workflow guide

You can transform your GitHub repository into a structured, SEO-friendly help center in just a few minutes. This guide walks you through the end-to-end process of connecting your source code to DocuBot and publishing your live documentation site.

Sign in and create your project

Establish your workspace and define the public identity of your documentation.

  1. Sign in to the DocuBot dashboard using your Google account.
  2. Click Add repository to start a new project.
  3. Enter a Display name for internal tracking.
  4. Define a unique URL slug. This becomes the public path where your users access the docs (for example, docubot.cc/your-product).

Connect repository sources

Link the source code that DocuBot analyzes to generate your content.

  1. Enter the GitHub repository URL for your product.
  2. If your repository is private, follow the prompts to authorize DocuBot via GitHub OAuth.
  3. Review the detected Role for the source. DocuBot automatically identifies if a repo is a primary UI application or an API source, but you can override this manually if needed.
  4. Add additional repositories if your product documentation spans multiple sources.

Define audiences and document types

Tailor the generated content to the specific needs of your user groups.

  1. Select the Audiences you serve, such as End Users, Administrators, or Developers.
  2. Review the Document types list. DocuBot pre-selects a recommended set of documents based on your chosen audiences.
  3. Add or remove specific document types, such as Quick start guides or API references, to match your project requirements.

Select documentation style and schedule

Configure the tone of your documentation and how often it stays in sync with your code.

  1. Choose a General style that matches your brand voice, such as the balanced “DocuBot Default” or the “Precision Technical” style for developer-heavy content.
  2. Set the Update frequency to Daily, Weekly, or Monthly.
  3. Select the Update time and your local time zone to ensure syncs happen during off-peak hours.

Trigger the initial sync

Start the AI-driven analysis and static site generation process.

  1. Click Save changes or Create documentation site to finalize your setup.
  2. DocuBot automatically queues an initial sync job.
  3. Monitor the Sync status on your repository card. You can see real-time progress as DocuBot plans and writes each individual document.

Verify and share published docs

Confirm your documentation is live and accessible to your users.

  1. Once the sync status shows “Up to date,” click the Live URL to view your published help center.
  2. Verify that interactive elements, such as the API reference viewer, are functioning correctly.
  3. Use the Download PDF link to get a portable, bookmarked version of your entire doc set.
  4. Share the link with your support team or embed it in your product.

Support and assistance

If you encounter issues during the setup or sync process, please reach out for help: