Skip to content
DocuBot documentation

Configuration guide

You can configure your DocuBot documentation site to align with your product’s audience, style, and update requirements. Follow these steps to establish your site identity, connect your code sources, and customize your documentation output.

1. Define site identity and access

You establish the public-facing identity of your documentation project by setting its name and URL.

  1. Enter a Display name. This is the internal name for the project in your workspace.
  2. Set a URL slug. This creates your public documentation address at docubot.cc/your-slug.
  3. Verify the live preview link to ensure the slug is correct.

2. Manage repository sources and roles

You connect the GitHub repositories that contain your product’s code. DocuBot uses these sources to learn your product and generate content.

  1. Add your GitHub repository URLs.
  2. Assign a Role to each source. Use Primary UI for your main application. Use UI app for secondary experiences, API reference for repos containing OpenAPI specs, and Reference only for supporting code.
  3. Ensure your GitHub account is connected if you’re using private repositories.

3. Select audiences and document types

You pick who the documentation is for, which determines the default set of pages DocuBot generates.

  1. Check the boxes for your target Audiences, such as End User, Administrator, Power User, or Developer.
  2. Review the Document types list. DocuBot auto-selects a preset based on your audiences, but you can manually toggle specific types like “Quick start guide” or “API reference” on or off.

4. Apply a general documentation style

You set the overall voice and structural rules for your entire documentation set.

  1. Choose a General style card.
  2. Select DocuBot Default for a balanced, friendly tone.
  3. Select Precision Technical for exact, scan-friendly developer docs.
  4. Select Approachable Guided for warm, plain-language onboarding.

5. Configure the synchronization schedule

You automate how often DocuBot refreshes your documentation from your source code.

  1. Select a Sync frequency. Free accounts are limited to Monthly syncs, while paid accounts unlock Weekly and Daily options.
  2. Choose a specific Update time and verify your Time zone.
  3. If using weekly or monthly syncs, select the specific day you want the update to run.

6. Provide advanced scenario and issue context

You can improve the relevance of your guides by providing specific details about your product’s workflows and known limitations.

  1. Open the Advanced doc inputs section.
  2. List your most important user workflows in the Scenario priorities area. DocuBot uses these to prioritize content in how-to guides.
  3. List known bugs or limitations in the Known issues & workarounds area to generate helpful KB articles.

7. Set up support contact information

You configure the contact details that appear on your public “Contact and support” page.

  1. Navigate to your Settings or Profile.
  2. Enter your Support email, Support phone, and Support portal URL.
  3. Save your changes to ensure users can find help when they need it.

Verification and next steps

Once you save your configuration, DocuBot queues an initial sync job. You can monitor the progress on your repository card in the dashboard. When the status changes to Up to date, your documentation is live at your configured URL slug.

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