Onboarding walkthrough

In this guide, we will walk through the process of transforming a GitHub repository into a live, structured documentation site in under 10 minutes.

To begin, navigate to the DocuBot dashboard and click the Sign in button. We use Google Sign-In to establish your session securely.

Expected Result: You arrive at the DocuBot overview page, which displays your workspace statistics and active projects.

2. Create a new documentation project

Click the Add repository button to initialize your first documentation site. You need to provide a Display name for internal tracking and a unique URL slug.

Expected Result: Notice that as you type the display name, DocuBot suggests a URL slug. This slug becomes your public address at docubot.cc/your-slug.

3. Connect your GitHub repository

Enter the URL of the GitHub repository you want to document. If your repository is private, click the Connect GitHub button to authorize DocuBot to access your code.

Expected Result: DocuBot validates the repository and adds it as a source for your project.

4. Define your audience and document types

Select the audiences you serve, such as End User, Administrator, or Developer. Based on these selections, DocuBot automatically suggests a preset list of document types, such as Quick Start Guides or API References.

Expected Result: You see a customized list of document types ready for generation. You can manually add or remove specific types to fit your needs.

5. Choose a documentation style

Select a general style to set the tone of your content. You can choose DocuBot Default for a balanced, friendly tone or Precision Technical for more exact, scan-friendly documentation.

Expected Result: Your project is now configured with a specific voice and structural rules that apply to every generated page.

6. Configure your sync schedule

Choose how often you want DocuBot to refresh your documentation. You can select Daily, Weekly, or Monthly updates and set a specific time in your local time zone.

Expected Result: Your documentation is now set to stay aligned with your latest code changes automatically.

7. Publish and verify your site

Click the Create documentation site button to trigger the initial generation process. Once the sync job completes, a live link appears on your repository card.

Expected Result: Click the live link to view your static documentation site. You can also download a PDF version of your documentation directly from the repository card.

Next steps

Now that your site is live, you can refine your documentation by providing specific scenario priorities or listing known issues in the Advanced doc inputs section of your repository settings.

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