Skip to content
DocuBot documentation

Quick start guide

You’ll create and publish a professional, static documentation site from a GitHub repository in under five minutes.

Prerequisites

Before you begin, ensure you have the following:

  • A Google account for signing in.
  • The URL of a GitHub repository you want to document.
  • GitHub authorization if you’re connecting a private repository.

1. Sign in to your workspace

Access the DocuBot dashboard by clicking Sign in on the homepage. Use your Google account to authenticate. Once signed in, you’re redirected to your personal workspace overview.

2. Create a documentation site

Click Add repository or Open workspace to start a new project. Enter a Display name for your project. DocuBot automatically suggests a URL slug based on this name, which becomes the public web address for your documentation (e.g., docubot.cc/your-project).

3. Connect a repository source

Paste your GitHub repository URL into the source field. DocuBot automatically detects the role of the repository, such as a Primary UI or an API reference. If you have a product that spans multiple repositories, you can add additional sources now or later.

4. Select your audiences

Choose the groups your documentation serves, such as End User, Administrator, or Developer. Selecting these audiences automatically generates a preset list of relevant document types, like “Quick start guide” or “API reference,” tailored to those users.

5. Launch the documentation pipeline

Review your selections and click Create documentation site. This starts the automated generation process. You can monitor the progress via the sync bar on your repository card, which shows the system planning, writing, and publishing your pages.

Verification and next steps

When the sync status changes to Up to date, click View docs on the repository card to see your live documentation site.

Now that your site is live, you can:

  • Refine document types: Add or remove specific guides in the repository settings.
  • Change styles: Select a different general style, such as “Precision Technical,” to change the voice of your docs.
  • Configure schedules: Set your documentation to update daily, weekly, or monthly to stay aligned with your code.

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