Settings reference
Use this reference to understand the configuration options available in the DocuBot dashboard. These settings control how your documentation is generated, where it is published, and how often it stays in sync with your code.
Project identity
These settings define how your documentation project appears within your workspace and to the public.
| Setting | Description | Impact |
|---|---|---|
| Display name | The internal name for your project. | Helps you identify the project in your dashboard. |
| URL slug | A unique identifier for your documentation site. | Determines the public URL (e.g., docubot.cc/your-slug). |
| GitHub connection | The OAuth link between DocuBot and your GitHub account. | Required to access and scan private repositories. |
Repository sources
You can connect multiple repositories to a single documentation site. Each source is assigned a role that determines how much “weight” it carries during AI analysis.
| Role | Description |
|---|---|
| Primary UI | The main customer-facing application. This receives the highest priority for context. |
| UI app | Secondary applications, such as admin consoles or mobile versions. |
| API reference | Repositories containing OpenAPI or Swagger specifications. |
| Reference only | Supporting libraries or backend code that provide technical context. |
Role detection
By default, DocuBot uses Auto detect to identify repository roles based on file structure and dependencies. You can override this by selecting a manual role for any source.
Audience and content
Your audience selection determines which document types DocuBot suggests for your project.
Audiences
Select one or more target groups:
- End User: General users of the product.
- Power User: Users seeking advanced features or automation.
- Administrator: Users managing system settings, security, or teams.
- Developer: Users integrating via APIs, SDKs, or webhooks.
Document types
You can choose exactly which pages to publish. Selecting an audience automatically enables a preset of document types, but you can manually add or remove types such as Quick start guides, Troubleshooting guides, or API references.
Documentation style
The general style controls the voice, tone, and structure of every generated page.
| Style | Tone | Best for |
|---|---|---|
| DocuBot Default | Clear and supportive | Mixed audiences and general help centers. |
| Precision Technical | Neutral and exact | Developer documentation and API references. |
| Approachable Guided | Warm and guiding | Onboarding and non-technical end users. |
Synchronization and scheduling
Scheduling settings control how often DocuBot checks your repositories for changes and regenerates your documentation.
| Frequency | Description |
|---|---|
| Manual only | Docs only update when you click “Rebuild documentation” in the dashboard. |
| Daily | Updates every day at your selected local time. |
| Weekly | Updates once per week on a specific day (e.g., every Monday). |
| Monthly | Updates once per month on a specific date. |
Time and zone
- Update time: The specific time of day the sync starts.
- Time zone: The zone used to calculate your update time. This defaults to your browser’s local zone.
Advanced generation inputs
Use these fields to provide the AI with specific context that cannot be found in the code alone.
- Scenario priorities: List the specific user workflows you want the documentation to emphasize.
- Known issues & workarounds: Document bugs or limitations and their temporary fixes so they appear in troubleshooting guides.
- Ignore patterns: Use glob patterns (e.g.,
**/ThirdParty_*/**) to exclude specific directories from being scanned. This is useful for skipping large vendored libraries.
Workspace and support details
These details are used to populate the “Contact and support” page in your generated documentation.
- Company name: The name of your organization.
- Support email: The primary email address for user help (e.g.,
support@ademero.com). - Support phone: The contact number for your support team (e.g.,
863-937-0272). - Support portal URL: The link to your external help desk or ticketing system (e.g.,
https://www.ademero.com).
If you need further assistance with these settings, please contact our team at support@ademero.com.