Secondary scenario how-to

This guide covers advanced management tasks for your DocuBot workspace, including handling private repository access, refining repository roles, and managing your documentation exports.

Authorize access to private repositories

DocuBot can generate documentation from both public and private GitHub repositories. While public repositories are accessible by default, private repositories require explicit authorization through GitHub OAuth.

1. Navigate to your workspace Settings or the Edit screen of a specific repository.
2. Locate the GitHub connection section.
3. Click Connect GitHub to initiate the authorization process.
4. Follow the prompts on GitHub to grant DocuBot read access to your repositories.

Once connected, your GitHub username appears in your settings, and DocuBot can successfully pull code from your private sources during the next sync.

Manually override repository roles

When you add multiple repositories to a single documentation site, DocuBot automatically detects the role of each source to determine how much weight it receives during content generation. If the automatic detection doesn’t align with your product structure, you can manually override it.

1. Open the Edit screen for your repository.
2. Find the Repository sources section.
3. Change the Role dropdown from “Auto detect” to one of the following:
   • Primary UI: The main customer-facing application experience.
   • UI app: Secondary experiences, such as admin consoles or mobile apps.
   • API reference: Sources containing OpenAPI or Swagger specifications.
   • Reference only: Supporting libraries or non-UI codebases.
4. Save your changes to apply the new weighting to your next documentation build.

Modify the automated sync schedule

You can control exactly when and how often DocuBot refreshes your documentation to ensure it stays aligned with your release cycle.

1. Navigate to the Edit screen for your repository.
2. Locate the Update frequency section.
3. Select your preferred cadence: Daily, Weekly, or Monthly.
4. Set the Update time using your local 24-hour clock.
5. Verify your Time zone in the workspace settings to ensure the sync runs at the intended moment.

Note that free accounts are limited to monthly syncs, while paid tiers unlock more frequent updates.

Download documentation for offline use

Every time DocuBot publishes your documentation site, it also generates a comprehensive PDF version. This file includes an automated table of contents and internal bookmarks for easy navigation.

1. Go to the Repositories page in your dashboard.
2. Locate the card for the project you wish to download.
3. Click the Download PDF link.

You can also find a download link in the footer of your live documentation site, making it easy for your end users to save a copy for offline reference.

Update support contact details

The contact information you provide in your workspace settings powers the “Contact and support” page in your public documentation. Keeping this updated ensures your users can always reach the right team.

1. Open your workspace Settings.
2. Locate the Support contacts section.
3. Update your Support email, Support phone, or Support portal URL.
4. Click Save support contacts.

If you need immediate assistance with your DocuBot workspace, you can reach our team at support@ademero.com, visit https://www.ademero.com, or call 863-937-0272.