Skip to content
DocuBot documentation

Initial configuration guide

After you connect your first repository, you must configure the core settings of your documentation site. This ensures your help center is professional, targeted to the right readers, and updates automatically as your code changes.

Core settings checklist

Before publishing, verify that you have addressed these critical configuration areas:

  • URL Slug: The unique public web address for your documentation.
  • Target Audiences: The specific groups (e.g., End Users, Developers) that define which document types are generated.
  • Documentation Style: The voice and tone used across all generated pages.
  • Sync Schedule: The frequency and time for automated updates.
  • Support Contacts: The contact details displayed to your users for help.

Configuration steps

Follow these steps to complete your initial setup and publish your first documentation set.

  1. Verify your URL slug Navigate to the repository settings in your dashboard. Locate the URL slug field and ensure it correctly represents your product. This slug forms the public address (e.g., docubot.cc/your-product-name).

    • Expected result: The live URL preview updates to show your locked public web address.

  2. Refine target audiences In the project configuration, select the audiences that will use your documentation. You can choose from End User, Power User, Administrator, or Developer.

    • Expected result: DocuBot automatically updates the list of available document types based on your selections.

  3. Select your documentation style Choose a general style from the available options, such as DocuBot Default or Precision Technical. Each style provides a different tone and focus for your content.

    • Expected result: The selected style becomes active, ensuring a consistent voice across your entire documentation site.

  4. Configure the sync schedule Set the frequency and local time for DocuBot to pull changes from your GitHub repository.

    • Note: Free accounts are limited to Monthly syncs. Paid accounts unlock Weekly and Daily update frequencies.
    • Expected result: Your update preferences are saved, and the system displays the next scheduled sync time in your preferred time zone.

  5. Add support contact details Go to your workspace settings and provide a support email, portal URL, or phone number. These details populate the “Contact and support” page in your generated docs.

    • Expected result: Your contact information is saved and ready to be included in the next build.

  6. Trigger the initial build Return to the repository card and click the Rebuild documentation button to start the generation process.

    • Expected result: The sync status changes to Queued or Syncing, and a progress bar appears showing the document generation phases.

Next steps

Once the sync status reaches Complete, your documentation is live. You can view the static site by clicking the View docs link on your repository card or download a PDF version for offline use.

If you need assistance during configuration, contact support at support@ademero.com, visit https://www.ademero.com, or call 863-937-0272.