Skip to content
DocuBot documentation

Installation and setup guide

In this guide, we will set up your DocuBot workspace and publish your first documentation site from a GitHub repository.

Prerequisites

Before we begin, ensure you have the following:

  • A valid Google account for authentication.
  • The URL of at least one GitHub repository you want to document.
  • GitHub account permissions to authorize access to your repositories.

Step 1: Sign in to your workspace

We start by accessing the DocuBot dashboard.

  1. Navigate to the DocuBot home page.
  2. Click Sign in or Open workspace.
  3. Select your Google account to complete the authentication.

Expected Result: You see the Overview screen of your new DocuBot workspace.

Step 2: Initialize a new documentation site

Now we begin the process of creating a dedicated home for your project’s documentation.

  1. From the sidebar, click Add repository.
  2. Alternatively, click the Manage repositories card on the Overview page.

Expected Result: The “Create documentation site” form appears.

Step 3: Define your documentation identity

We need to establish how your documentation appears to the public.

  1. Enter a Display name. This is the internal name used to identify the project in your dashboard.
  2. Review the URL slug. DocuBot suggests a slug based on your display name, but you can customize it. This slug defines the public web address (e.g., docubot.cc/your-slug).

Expected Result: Your project has a unique identity and a reserved public URL.

Step 4: Connect your repository sources

We will now link your source code to the documentation engine.

  1. In the Repository sources section, paste your GitHub repository URL.
  2. If your repository is private, click Connect GitHub to authorize DocuBot via OAuth.
  3. Notice that DocuBot automatically detects the role of the repository (such as Primary UI or API reference). You can manually override this if necessary.

Expected Result: The repository status updates to show it is successfully connected.

Step 5: Configure audiences and document types

We tailor the content to the people who will read it.

  1. Select one or more Audiences (End User, Power User, Administrator, or Developer).
  2. Observe that DocuBot auto-selects a preset list of Document types based on your audiences.
  3. Add or remove specific document types to refine exactly what we will publish.

Expected Result: Your documentation set is customized for your target users.

Step 6: Set documentation style and automation

We choose the voice of the documentation and how often it stays in sync with your code.

  1. Select a General style (such as DocuBot Default or Precision Technical) to control the tone and layout.
  2. Choose an Update frequency (Daily, Weekly, or Monthly).
  3. Set the Update time and verify your Time zone to ensure syncs happen when you expect them.

Expected Result: A synchronization schedule is active and a visual style is applied.

Step 7: Verify deployment

Finally, we confirm that your documentation is live.

  1. Click Create documentation site.
  2. Wait for the initial sync job to complete. You can monitor progress on the repository card.
  3. Once the status shows “Up to date,” click View docs to see your live site.
  4. Click Download PDF to verify that the portable version of your documentation is ready.

Expected Result: Your documentation site is accessible at your unique URL and the PDF export is available for download.

Troubleshooting initial setup

If you encounter issues during setup, check the following:

  • GitHub Connection Errors: Ensure you have authorized DocuBot to access the specific organization or repository. If a private repo is not appearing, try reconnecting your GitHub account in Settings.
  • Slug Collisions: If a slug is already in use by another user, you must choose a different, unique URL slug.
  • Sync Failures: Check the repository card for specific error messages. Common causes include empty repositories or invalid OpenAPI specifications.

If you need further assistance, contact our support team at support@ademero.com or visit https://www.ademero.com. You can also reach us by phone at 863-937-0272.

Next steps

Now that your site is live, you can refine your content by providing Scenario priorities or Known issues in the repository settings to generate even more helpful guides.