Skip to content
DocuBot documentation

Customization guide

You can personalize your DocuBot documentation site to align with your brand voice and meet the specific needs of your users. By adjusting project settings, selecting documentation styles, and defining update schedules, you ensure your help center remains relevant and professional.

Personalize your project identity

You can change how your project appears both internally and to the public.

  1. Update the display name: Set a friendly name for the project to identify it within your dashboard.
  2. Customize the URL slug: Define the unique path for your documentation (e.g., docubot.cc/your-product-name). This slug becomes the permanent public link for your help center.

Select your documentation style

DocuBot uses styles to determine the tone and structure of your generated content. You can choose one general style per project:

  • DocuBot Default: A balanced, clear, and friendly tone suitable for mixed audiences.
  • Precision Technical: An exact, scan-friendly style designed for developers and administrators who require high accuracy and minimal fluff.
  • Approachable Guided: A warm, supportive style that uses plain language to help new or non-technical users succeed quickly.

Refine your audience and document set

You control who the documentation serves and which specific pages DocuBot generates.

  1. Select target audiences: Choose from End User, Power User, Administrator, or Developer.
  2. Customize document types: Selecting an audience automatically suggests a preset of document types (like Quick Start guides or API references). You can manually include or exclude specific document types to fine-tune your doc set.

Configure update schedules

Keep your documentation aligned with your code by setting an automated refresh cadence.

  1. Choose a frequency: Set your syncs to run Daily, Weekly, or Monthly.
  2. Set the timing: Specify the local time and time zone for the update to occur.
  3. Manual sync: If you have a paid account, you can trigger an immediate rebuild of your documentation at any time from the repository settings.

Advanced content inputs

You can improve the quality of AI-generated content by providing specific context that the code alone might not reveal.

  • Scenario priorities: List the primary workflows or use cases you want the documentation to emphasize.
  • Known issues and workarounds: Provide details on existing limitations and their temporary fixes so DocuBot can generate accurate troubleshooting articles.

Manage documentation scope

To keep your documentation focused, you can exclude irrelevant parts of your repository from the analysis process.

  1. Define ignore patterns: Use glob patterns (e.g., **/ThirdParty_*/**) to tell DocuBot which directories or files to skip.
  2. Filter third-party code: Excluding large vendored libraries or generated assets reduces noise and improves the accuracy of your generated guides.

Get support

If you need assistance customizing your documentation site, you can reach out through the following channels: