Core scenario how-to

You can transform your GitHub repositories into a structured, search-ready help center in just a few minutes. This guide walks you through establishing your project identity, connecting your source code, and automating the update schedule.

Create your documentation project

Start by establishing the public identity and web address for your documentation.

1. Sign in to the DocuBot dashboard using your Google account.
2. Click Add repository to start a new project.
3. Enter a Display name. This is the internal name used to identify the project in your workspace.
4. Choose a unique URL slug. This defines your public web address at docubot.cc/[your-slug].

Expected Result: Your project dashboard is created, and the system prepares the source configuration screen.

Connect your GitHub repositories

Link the source code that DocuBot will use to generate your documentation.

1. Enter the GitHub repository URL for your product.
2. If your repository is private, click Connect GitHub to authorize access via OAuth.
3. Assign a Role to the repository. Use Primary UI for your main application and API Reference for repositories containing OpenAPI or Swagger specifications.
4. Click Add another repo if your product spans multiple repositories.

Expected Result: Your repositories are successfully attached as active content sources.

Configure audiences and documentation styles

Tailor the generated content to your specific users and your brand’s voice.

1. Select your target Audiences, such as End User, Administrator, or Developer. DocuBot uses these to auto-select the most relevant document types.
2. Choose a General style, such as Precision Technical for exactness or Approachable Guided for a warmer tone.
3. Review the Document types list. You can manually include or exclude specific templates like Quick Start Guides or Troubleshooting Guides.
4. Use the Advanced doc inputs section to list specific scenarios or known issues you want the documentation to prioritize.

Expected Result: The system saves your preferences and prepares a customized documentation plan.

Set your synchronization schedule

Automate the process of keeping your documentation aligned with the latest code your team ships.

1. Select a Sync frequency. You can choose Daily, Weekly, or Monthly updates depending on your account tier.
2. Choose a specific Update time for the sync to run.
3. Confirm your Time zone to ensure the schedule aligns with your local operations.
4. Click Create documentation site or Save changes.

Expected Result: DocuBot establishes a recurring update schedule and queues the initial generation of your documentation site.

Next steps

Once your site is configured, you can monitor the progress of the documentation build directly from your repository card. When the sync is complete, click View docs to see your live help center or Download PDF to save a portable version of your documentation.

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