Skip to content
DocuBot documentation

Code examples

Use these examples to configure your documentation project settings and advanced inputs. These snippets help you control the scope and focus of your generated help center.

Ignore patterns

Use glob patterns to exclude third-party libraries, build artifacts, or non-essential files from your documentation. This ensures the generator focuses only on your relevant source code.

# Exclude dependency folders
node_modules/**
vendor/**


# Exclude build and distribution folders
dist/**
build/**
out/**


# Exclude specific file types
**/*.log
**/*.tmp
**/*.map


# Exclude large third-party assets
**/ThirdParty_*/**
**/assets/vendor/**

Scenario focus inputs

List the primary user workflows you want the documentation to prioritize. Format these as a plain-text list with one goal-oriented task per line.

How to create and verify a new user account
How to configure custom notification preferences
How to export project data to a CSV file
How to integrate a third-party calendar
How to manage team permissions and roles

Known issues and workarounds

Document temporary solutions for known limitations. Format these as pairs containing a clear symptom or issue title followed by the recommended resolution steps.

Issue: Dashboard charts do not render in Internet Explorer 11.
Workaround: Use a modern browser such as Chrome, Firefox, or Edge.


Issue: Large PDF exports may time out during generation.
Workaround: Reduce the number of selected document types and try the export again.


Issue: GitHub connection fails for repositories with SSO enabled.
Workaround: Ensure your GitHub personal access token has the 'repo' scope authorized for your organization's SSO.

Public API availability

A public API for integrating directly with DocuBot is not available in the current version. If you require programmatic access or custom integrations, please reach out to our support team for assistance.

Contact support

If you need help with configuration or have questions about integration, use the following channels: