Skip to content
DocuBot documentation

Onboarding walkthrough

This guide walks you through creating your first documentation site, connecting a repository, and publishing your first set of static help pages. You can complete this entire process in under ten minutes.

Access your workspace

Sign in to the platform to begin managing your documentation projects.

  1. Navigate to the DocuBot homepage.
  2. Click the Sign in button.
  3. Authenticate using your Google account.

Expected result: You are redirected to the DocuBot Overview dashboard where you can see your active repositories and workspace status.

Create a documentation site

Define the public identity and URL for your documentation project.

  1. Navigate to the Add repository section from the sidebar.
  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 web address where your documentation will be hosted.

Expected result: A new documentation project is initialized with a unique URL slug, visible in the live URL preview.

Connect your GitHub repository

Link the source code repository that DocuBot analyzes to generate your content.

  1. Enter your GitHub repository URL in the source field.
  2. If the repository is private, click Connect GitHub to authorize access via OAuth.
  3. Assign a role to the repository, such as Primary UI for your main application or API reference for technical specifications.

Expected result: The repository is validated. If it is private, the connection status updates to show it is authorized.

Select your audiences and style

Configure who the documentation is for and the tone it should use.

  1. Select your target Audiences (such as End User, Administrator, or Developer).
  2. Review the Document types list. DocuBot automatically selects a preset of templates based on your chosen audiences.
  3. Choose a General style card to set the overall voice and structural rules for your pages.

Expected result: The system prepares a customized plan for your documentation set based on your selections.

Configure the update schedule

Set how often your documentation stays in sync with your code changes.

  1. Select an Update frequency (Daily, Weekly, or Monthly).
  2. Choose a specific Update time using the time picker.
  3. Verify that the displayed Time zone matches your local preference.

Expected result: A recurring synchronization task is established to ensure your docs never fall behind your code.

Publish and view your documentation

Trigger the initial generation process and view the live site.

  1. Click Create documentation site to save your settings and start the first sync.
  2. Monitor the Syncing status indicator on your repository card.
  3. Once complete, click the View docs button to see your live site.

Expected result: Your documentation site is live at your unique slug, and a Download PDF link is available for offline use.

Next steps

Now that your site is live, you can further refine your content:

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