Skip to content
DocuBot documentation

Configuration guide

Configure your DocuBot documentation site to align with your product’s audience, style, and update requirements. By following these steps, you ensure your generated help center is accurate, well-structured, and stays in sync with your code changes.

Define your documentation identity

Set the public-facing name and URL for your documentation site. This identity helps users recognize your product and provides a permanent link for your help resources.

  1. Enter a Display name. This is the internal name used to identify the project in your dashboard.
  2. Set the URL slug. This creates your public documentation path at docubot.cc/your-slug.
  3. Review the live preview to ensure the URL matches your branding requirements.

Connect repository sources

Link the GitHub repositories that contain the source code and OpenAPI specs for your product. DocuBot analyzes these sources to generate content.

  1. Provide the GitHub repository URL for each component of your product.
  2. Assign a Role to each source:
    • Primary UI: The main customer-facing application.
    • UI app: Secondary interfaces like admin consoles or mobile apps.
    • API reference: Repositories containing OpenAPI/Swagger specifications.
    • Reference only: Supporting codebases without a user interface.
  3. If your repositories are private, ensure you have authorized the GitHub connection in your account settings to allow DocuBot access.

Select target audiences and document types

Choose who the documentation is for and which specific guides you want to publish. DocuBot uses these selections to filter the type of information it extracts from your code.

  1. Check the boxes for your target Audiences (e.g., End User, Administrator, Developer).
  2. Review the Document types list. Selecting an audience automatically enables a recommended preset of documents, such as Quick start guides or API references.
  3. Manually add or remove specific document types to tailor the set to your needs.

Choose a documentation style

Apply a general style overlay to control the tone and focus of the generated content. This ensures consistency across all pages in your help center.

  1. Select a General style from the available options:
    • DocuBot Default: Balanced and friendly for mixed audiences.
    • Precision Technical: Exact and scan-friendly for developers and admins.
    • Approachable Guided: Warm and supportive for non-technical users.
  2. Review the style summary to confirm the tone matches your brand voice.

Configure the update schedule

Set the frequency and timing for automatic documentation refreshes to keep your help center aligned with your latest releases.

  1. Choose an Update frequency. Options include Daily, Weekly, Monthly, or Manual only. Note that free accounts are limited to monthly synchronization.
  2. Set the Update time and confirm your local time zone.
  3. For weekly or monthly schedules, select the specific day you want the sync to trigger.

Provide advanced inputs and ignore patterns

Refine the AI’s focus by providing context about priority workflows or excluding irrelevant code.

  1. List Scenario priorities to tell the generator which user workflows are most important to document.
  2. Enter Known issues & workarounds to help the system generate troubleshooting articles.
  3. Define Ignore patterns using glob syntax (e.g., **/ThirdParty_*/**) to exclude large third-party libraries or vendored code that should not be documented.

Verify the configuration

Trigger an initial sync to confirm all settings produce the desired documentation site.

  1. Save your changes to queue an initial Sync job.
  2. Monitor the Sync status indicator on your repository card.
  3. Once the status shows “Up to date,” click the live documentation link to view your published help center.

Support

If you encounter issues during configuration or need assistance with repository roles, contact support: