Skip to content
DocuBot documentation

Quick start guide

You can transform any GitHub repository into a professional, static documentation site in just a few 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 account access if the repository is private.

Create your documentation site

Follow these steps to generate and publish your documentation.

  1. Sign in to your workspace Navigate to the dashboard and sign in using your Google account. You’ll arrive at your workspace overview.

  2. Start a new project Click Add repository or Create documentation site. Enter a Display name for your project and choose a unique URL slug. This slug becomes the public web address for your documentation (e.g., docubot.cc/your-slug).

  3. Connect your GitHub repository Paste your GitHub repository URL into the source field. If your repository is private, click Connect GitHub to authorize access via OAuth.

  4. Select audiences and document types Choose the target audiences for your documentation, such as End User or Developer. DocuBot automatically pre-selects a set of document types based on your choice. You can manually add or remove specific guides from the list.

  5. Choose a documentation style Select a general style for your site. The DocuBot Default style provides a balanced, friendly tone, while Precision Technical is optimized for scanable, exact developer references.

  6. Publish your site Click Create documentation site. DocuBot immediately begins analyzing your code and generating the content. You can monitor the progress of the initial sync on your repository card.

Verification and next steps

Once the sync status changes to Up to date, click the live URL link on your repository card. You should see a fully rendered, interactive documentation site hosted at your chosen slug.

To further refine your documentation:

  • Update settings: Add specific scenario focuses or known issues in the Advanced doc inputs section to improve guide accuracy.
  • Schedule updates: Set a daily, weekly, or monthly sync frequency in the Update frequency settings to keep docs aligned with your code changes.

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