Skip to content
DocuBot documentation

Workflow guide

This guide walks you through the complete process of creating a documentation site, connecting your source code, and configuring automated updates. By the end of this workflow, you’ll have a live, static help center hosted at a custom URL.

Access your workspace

Before you can build your documentation, you must authenticate with the platform to access your personal dashboard.

  1. Navigate to the DocuBot homepage.
  2. Click the Sign in button.
  3. Authenticate using your Google account.
  4. Once signed in, you’ll land on the Overview page of your workspace.

Create a documentation site

Define the identity and the public web address where your users will access your help content.

  1. Click Add repository from the sidebar or the Overview page.
  2. Enter a Display name. This is the internal name used to identify the project in your workspace.
  3. Enter a URL slug. This defines the public address of your documentation (e.g., docubot.cc/your-product-name).
    • Note: Slugs must use lowercase letters, numbers, and dashes only.
  4. Verify the live preview URL displayed below the slug field.

Connect repository sources

Link your GitHub repositories to provide the source material for the documentation engine.

  1. In the Repository sources section, enter your GitHub repository URL.
  2. If your repository is private, click Connect GitHub to authorize access via OAuth.
  3. Assign a Role to the repository:
    • Primary UI: The main customer-facing application experience.
    • UI app: Secondary applications like admin consoles or mobile apps.
    • API reference: Repositories containing OpenAPI or Swagger specifications.
    • Reference only: Supporting repositories without a user interface.
  4. Click Add another repo if your product spans multiple repositories.

Select audiences and document types

Tailor the generated content to meet the specific needs of your different user groups.

  1. Check the boxes for your target Audiences (End User, Power User, Administrator, or Developer).
  2. Review the Document types list. DocuBot automatically selects a preset based on your audiences.
  3. Manually add or remove specific document types to refine your doc set.
  4. Choose a General style (such as DocuBot Default or Precision Technical) to control the overall tone and voice of the writing.

Configure the update schedule

Set the frequency and timing for automated documentation refreshes to ensure your docs stay aligned with your code.

  1. Select a Sync frequency (Daily, Weekly, or Monthly).
  2. Choose a specific Update time for the sync to run.
  3. Ensure the Time zone matches your local preference. You can update this in your workspace Settings.
  4. (Optional) Provide Scenario priorities or Known issues in the advanced inputs to give the engine more context for specific guides.

Publish and verify documentation

Trigger the initial generation process and view your live documentation site.

  1. Click Create documentation site to save your settings and start the first sync.
  2. Return to the Repositories page to monitor the progress. You’ll see a “Syncing now” status indicator and a progress bar.
  3. Once the sync is complete, the status changes to “Up to date.”
  4. Click View docs to open your live documentation site in a new tab.
  5. Click Download PDF if you wish to view or share the offline version of your documentation.

Support

If you encounter issues during setup or need assistance with repository roles, please contact our support team: