Secondary scenario how-to

This guide covers advanced tasks to help you customize how DocuBot analyzes your code and how your final documentation is presented to your audience.

Download PDF exports

DocuBot automatically generates a portable PDF version of your documentation during every sync. This file includes a table of contents and functional bookmarks for easy navigation.

1. Navigate to the Repositories page in your dashboard.
2. Locate the card for the project you want to download.
3. Click Download PDF in the project links section.
4. The PDF opens in a new tab or downloads directly to your device depending on your browser settings.

Refine content with advanced inputs

You can influence the AI’s focus by providing specific scenarios or known issues. This ensures that the generated “How-to” and “Workaround” articles prioritize the topics most relevant to your users.

1. Select Edit settings on your repository card.
2. Scroll to the bottom and expand the Advanced doc inputs section.
3. In the Scenario priorities field, list the primary workflows you want the documentation to emphasize. Enter one scenario per line.
4. In the Known issues & workarounds field, list specific bugs or limitations and their temporary fixes.
5. Click Save changes. The next sync uses these inputs to shape the content.

Exclude files from documentation

If your repository contains large third-party libraries, vendored code, or irrelevant assets, you can use ignore patterns to prevent DocuBot from analyzing them. This improves generation speed and accuracy.

1. Open the Edit page for your repository.
2. Expand the Ignore patterns section.
3. Enter glob patterns for the files or directories you want to skip. Enter one pattern per line (for example, **/ThirdParty_*/**).
4. Click Save changes.

Manage multi-repository products

DocuBot allows you to group multiple GitHub repositories under a single documentation site. This is useful for products that consist of a core API, a web dashboard, and a mobile app.

1. In the repository settings, locate the Repository sources section.
2. Click Add another repo to include additional GitHub URLs.
3. Assign a Role to each source:
   • Primary UI: The main customer-facing experience.
   • UI app: Secondary dashboards or consoles.
   • API reference: Sources containing OpenAPI or Swagger specifications.
   • Reference only: Supporting codebases that provide context but no direct UI.
4. Click Save changes. DocuBot consolidates these sources into one cohesive help center.

Update workspace and support details

The contact information displayed on your “Contact and support” documentation page is managed globally in your workspace settings.

1. Navigate to the Settings page from the sidebar.
2. Update the Workspace details to change your primary company contact information.
3. Update the Support contacts section to change the email, phone number, or portal URL that appears in your public docs.
4. Click Save support contacts.

If you need further assistance with advanced configuration, contact our team at support@ademero.com, visit https://www.ademero.com, or call 863-937-0272.