Getting started guide

DocuBot turns your GitHub repositories into structured, static help centers. By connecting your code to our documentation engine, you can provide your users with high-quality, searchable documentation that stays in sync with your latest releases.

In this guide, you’ll set up your first documentation site, connect your source code, and publish a live help center.

Access your workspace

To begin managing your documentation projects, you must authenticate with the DocuBot platform.

1. Navigate to the DocuBot dashboard.
2. Click the Sign in with Google button.
3. Select your preferred Google account to complete the authentication.

Expected result: You are signed in and redirected to your workspace overview screen.

Create your documentation site

Every documentation site needs a public identity and a unique web address where your users can find it.

1. Click Add repository or Create documentation site from your dashboard.
2. Enter a Display name. This is the internal name you’ll see in your workspace.
3. Define your URL slug. This creates your public web address at docubot.cc/your-slug.
4. Review the live preview link to ensure the address is correct.

Expected result: Your documentation project is initialized with a unique URL.

Connect your GitHub repositories

DocuBot analyzes your source code to generate accurate content. You can link one or multiple repositories to a single documentation site.

1. Enter the GitHub repository URL for your product.
2. If your repository is private, click Connect GitHub to authorize access via OAuth.
3. Observe the Role detection. DocuBot automatically identifies if a repo is a Primary UI, an API reference, or a supporting project. You can manually override these roles if needed.
4. Click Add another repo if your product spans multiple repositories.

Expected result: Your source code is linked, and DocuBot is ready to analyze the content.

Define audiences and documentation style

Tailor your documentation to the people who use your product and choose a tone that matches your brand.

1. Select your Audiences (such as End User, Administrator, or Developer).
2. Review the Document types checklist. DocuBot auto-selects relevant templates based on your audiences, but you can add or remove specific guides.
3. Choose a General style. For example, select Precision Technical for exact, scan-friendly docs or Approachable Guided for a warmer, onboarding-focused tone.

Expected result: A customized set of document types is prepared for generation.

Configure your update schedule

Automate the synchronization between your code changes and your documentation to ensure your help center never falls behind.

1. Select a Sync frequency (Daily, Weekly, or Monthly).
2. Choose a specific Update time in your local time zone.
3. Verify that your Preferred time zone is set correctly in your account settings.

Expected result: An automated update schedule is established for your project.

Verify your live documentation

Once your project is configured, DocuBot begins the initial build process.

1. Monitor the Sync status indicator on your repository card.
2. Wait for the status to change to Up to date.
3. Click the View docs button to open your live site.
4. Check the navigation sidebar to ensure all selected document types are present.

Expected result: Your documentation site is live and accessible at your unique URL.

Next steps

Now that your baseline site is running, you can further refine your content by providing specific scenario focuses or known issues in the Advanced doc inputs section of your repository settings.

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