First-time setup guide

You’ll set up your first DocuBot project to turn your GitHub repositories into a structured, searchable help center. This process establishes your workspace, connects your code, and defines how your documentation looks and feels.

Prerequisites

Before you begin, ensure you have the following:

• A Google account for authentication.
• The URL of at least one GitHub repository you want to document.
• GitHub authorization if you intend to document private repositories.

1. Sign in to your workspace

Establish your user account to access the management dashboard.

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

Notice that you are redirected to the dashboard overview screen, which serves as the central hub for all your documentation projects.

2. Create your documentation site

Define the identity and public web address of your help center.

1. Click Add repository or Create documentation site.
2. Enter a Display name. This is the internal name used to identify the project in your workspace.
3. Enter a URL slug. This creates the unique public address for your documentation (e.g., docubot.cc/your-slug).

Notice that the system provides a live preview of your documentation URL as you type.

3. Connect your GitHub repositories

Link the source code repositories that DocuBot analyzes to generate content.

1. In the Repository sources section, enter your GitHub repository URL.
2. If the repository is private, click Connect GitHub to authorize access via OAuth.
3. Choose a Role for the repository. You can leave this as Auto detect or manually specify if it is a Primary UI, a secondary app, or an API reference.

Notice that you can add multiple repositories if your product spans several codebases.

4. Define your target audiences

Select the user groups you serve to automatically determine the most relevant document types.

1. Check the boxes for your intended audiences: End User, Power User, Administrator, or Developer.
2. Review the Document types list that appears.

Notice that DocuBot pre-selects a default set of templates—like Quick Start Guides or API References—based on your audience choices. You can manually add or remove specific types from this list.

5. Choose your documentation style

Select the tone and structural rules applied to every generated page.

1. Scroll to the General style section.
2. Select a style card that matches your brand voice, such as Precision Technical for developers or Approachable Guided for non-technical users.

Notice that each style includes a summary of its tone and focus to help you choose the best fit.

6. Configure the update schedule

Set the frequency and timing for automated synchronization with your latest code.

1. Select a Sync frequency: Daily, Weekly, or Monthly.
2. Enter a Update time in your local format.
3. Verify that the Time zone matches your current location.

Notice that free accounts are limited to monthly syncs, while paid accounts unlock more frequent updates.

Next actions after setup

Once you click Create documentation site, the system enqueues your first synchronization job.

• Monitor progress: View the repository card on your dashboard to see the real-time sync status.
• View your docs: Once the status changes to “Up to date,” click View docs to see your live help center.
• Refine output: Use the Advanced doc inputs in your repository settings to provide specific scenarios or known issues for the AI to prioritize.
• Add support details: Go to Settings to configure your support email and portal URL so they appear correctly in your generated “Contact and support” pages.

If you encounter issues during setup, contact our support team at support@ademero.com, visit https://www.ademero.com, or call 863-937-0272.