Skip to content
DocuBot documentation

First-time setup guide

In this guide, we will establish your user account, connect your first GitHub repository, and publish a live documentation site. By the end of these steps, you will have an automated pipeline that keeps your documentation aligned with your code.

Prerequisites

Before we begin, ensure you have the following:

  • A Google account for authentication.
  • The URL of a GitHub repository you wish to document.
  • GitHub account access if the repository is private.

1. Sign in to your workspace

We start by establishing your identity and accessing the management tools.

  1. Navigate to the DocuBot dashboard.
  2. Click the Sign in button and follow the prompts to authenticate with your Google account.
  3. Notice that you are redirected to the dashboard overview where you can see your workspace status.

2. Create a documentation project

Next, we define the public identity and the web address for your documentation.

  1. Click the Add repository button from the overview or the sidebar.
  2. Enter a Display name for your project.
  3. Enter a unique URL slug.
  4. Notice that the URL slug preview updates in real-time to show your future public documentation path (e.g., docubot.cc/your-product).

3. Connect your GitHub repository

We must link your source code so the AI can analyze it to generate content.

  1. Paste your GitHub repository URL into the Source field.
  2. If your repository is private, click the Connect GitHub button to authorize access via OAuth.
  3. Notice that DocuBot validates the repository and loads the metadata once the connection is successful.

4. Define audiences and document types

We tailor the generated content to meet the specific needs of your readers.

  1. Select one or more target Audiences (such as End User or Developer) using the checkboxes.
  2. Review the Document types list. DocuBot automatically pre-selects a recommended set of pages based on your chosen audiences.
  3. Add or remove specific document types to further customize your documentation set.

5. Select a documentation style and schedule

We choose the writing tone and determine how often your documentation refreshes.

  1. Review the General style cards and select the tone that best fits your brand (e.g., DocuBot Default or Precision Technical).
  2. Choose a Sync frequency (Daily, Weekly, or Monthly).
  3. Set the Update time and ensure your preferred time zone is correct in the settings.

6. Trigger the initial synchronization

Finally, we launch the generation process to build your site.

  1. Click the Create documentation site button at the bottom of the form.
  2. Notice that you are returned to the repository list where a progress indicator shows the current phase of generation.
  3. Once the status changes to Up to date, click View docs to see your live site.

Verification and next steps

Your documentation is now live and scheduled for automated updates. To further refine your content, you can edit the repository settings to provide “Scenario priorities” or “Known issues,” which help the AI write more effective how-to guides and troubleshooting articles.

If you encounter any issues during setup, contact our team at support@ademero.com or visit https://www.ademero.com.