Installation and setup guide

You will complete the initial configuration of your DocuBot workspace and publish your first documentation site in just a few minutes.

Prerequisites

Before you begin, ensure you have the following:

• A Google account for authentication.
• A GitHub account with access to the repositories you want to document.
• A unique name for your documentation project.

1. Sign in to your workspace

Establish your secure session to access the management dashboard.

1. Navigate to the DocuBot landing page.
2. Click the Sign in button.
3. Select your Google account to authenticate.
4. Notice that you are redirected to the dashboard overview where your display name appears.

2. Connect your GitHub account

Authorize DocuBot to access your repositories so it can analyze your code and generate content.

1. Go to the Settings or Profile area in the dashboard.
2. Click Connect GitHub.
3. Follow the OAuth authorization prompts from GitHub to grant access.
4. Verify that your GitHub username appears as “Connected” in your profile.

3. Create a documentation project

Define the public identity and URL for your documentation site.

1. Select Add repository or Create documentation site from the dashboard.
2. Enter a Display name for your project.
3. Enter a URL slug. This becomes the public path for your docs (e.g., docubot.cc/your-slug).
4. Check the URL preview to ensure the slug is correct.

4. Attach repository sources

Link the specific codebases you want DocuBot to analyze for this project.

1. In the Repository sources section, enter the GitHub URL for your primary repository.
2. Click Add another repo if your product spans multiple repositories.
3. Observe the role detection labels. DocuBot automatically identifies roles like Primary UI or API Reference, but you can override these manually if needed.

5. Configure audiences and document types

Tailor the generated content to your specific users and documentation needs.

1. Select the target Audiences for your docs, such as End User, Administrator, or Developer.
2. Notice that DocuBot pre-selects a set of document types based on your audiences.
3. Review the Document types list and check or uncheck specific items to customize your doc set.

6. Select a documentation style

Choose the voice and tone that best fits your brand.

1. Review the available General style options, such as DocuBot Default or Precision Technical.
2. Select the style that matches your preferred communication tone.
3. This style applies to every page generated within this project.

7. Set the update schedule

Automate the synchronization between your code and your documentation.

1. Choose a Sync frequency (Daily, Weekly, or Monthly).
2. Select the Update time and confirm your local time zone.
3. This ensures your documentation stays aligned with your latest code changes automatically.

8. Verify the initial build

Confirm that your documentation is successfully generated and published.

1. Click Save changes or Create documentation site to trigger the initial sync.
2. Monitor the Sync status indicator on your repository card.
3. Once the status shows Succeeded, click the live link to view your new documentation site.

Next steps

Now that your site is live, you can refine your content 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, contact our support team at support@ademero.com, visit our support portal, or call us at 863-937-0272.