Skip to content
DocuBot documentation

Core scenario how-to

DocuBot transforms your GitHub repositories into structured, static help centers. You can manage multiple repositories under a single documentation site, tailor content for specific audiences, and ensure your docs stay aligned with your latest code changes.

Create a new documentation site

Setting up a documentation site involves connecting your source code and defining how the public accesses your content.

  1. Sign in to your workspace. Use your Google account to access the DocuBot dashboard.
  2. Start a new project. Click Add repository from the dashboard overview.
  3. Define your project identity. Enter a Display name for internal tracking and a unique URL slug. The slug determines your public documentation address (e.g., docubot.cc/your-slug).
  4. Connect your source code. Provide the GitHub repository URLs for your product. You can add multiple repositories if your product consists of several components, such as a web app and an API.
  5. Assign repository roles. DocuBot automatically detects roles like Primary UI or API Reference, but you can manually override these to ensure the AI prioritizes the correct context.
  6. Select your audiences. Choose from End User, Power User, Administrator, or Developer. DocuBot uses these selections to recommend a preset list of document types.
  7. Refine your document types. Review the recommended list and check or uncheck specific types, such as Quick Start Guides or API References, to match your needs.

Configure documentation styles and sync schedules

Once your project is created, you can customize the voice of your documentation and decide how often it refreshes.

  1. Choose a documentation style. Select a general style that matches your brand’s voice. Options include DocuBot Default for a balanced tone, Precision Technical for exactness, or Approachable Guided for non-technical readers.
  2. Set the update frequency. Choose how often DocuBot scans your code for changes. You can select Daily, Weekly, Monthly, or Manual only.
  3. Schedule the update time. Pick a specific local time and time zone for the sync to occur. This ensures updates happen during off-peak hours for your team.
  4. Provide advanced inputs. Optionally list specific scenarios you want the AI to prioritize or known issues that require workarounds in the generated text.
  5. Save your changes. Click Save changes to apply your configuration.

Manage and manually sync repositories

You can monitor the health of your documentation and trigger immediate updates whenever you ship significant code changes.

  1. Monitor sync status. View your repository cards in the dashboard to see the Last sync timestamp and current status, such as Up to date or Syncing.
  2. Trigger a manual rebuild. If you need to update your docs before the next scheduled sync, click Rebuild documentation on the repository card.
  3. Track progress. During a sync, a progress bar shows how many documents have been generated. You can also see the specific phase, such as “Planning” or “Writing.”
  4. Download PDF exports. Every documentation site includes a generated PDF version. Click Download PDF on the repository card to save a bookmarked, offline version of your help center.
  5. Access live docs. Click View docs to open your static documentation site in a new tab and verify the content.

Get support

If you encounter issues while setting up your repositories or managing your sync schedules, our team is here to help.