First admin user setup

You can complete the initial configuration of your DocuBot workspace to begin generating documentation in just a few minutes. This guide walks you through establishing your identity, linking your code, and scheduling your first documentation sync.

Prerequisites

Before you begin, ensure you have the following:

• A Google account for authentication.
• The URL of at least one GitHub repository you want to document.
• Administrator access to any private repositories you intend to connect.

1. Sign in to the dashboard

Establish your administrator identity using a secure authentication provider.

1. Navigate to the DocuBot landing page.
2. Click the Sign in button.
3. Follow the prompts to authenticate with your Google account.

Expected result: You’re granted access to the DocuBot workspace management interface and the overview screen.

2. Create your documentation site

Define the public identity and web address for your documentation.

1. Enter a Display name for your project. This is the internal name used within your workspace.
2. Configure your URL slug. This defines the unique public web address where your documentation will live (e.g., docubot.cc/your-product).
3. Review the Live URL preview to ensure the address meets your requirements.

Expected result: A unique URL slug is reserved for your product documentation.

3. Connect source repositories

Link the GitHub repositories that contain the source code for your documentation.

1. Enter your GitHub repository URL.
2. If the repository is private, follow the prompts to authorize DocuBot via GitHub OAuth.
3. Review the Repository role detection indicators. DocuBot automatically identifies if a repo is a Primary UI, a secondary app, or an API source.

Expected result: DocuBot identifies the repository roles and prepares to scan for content.

4. Configure audiences and styles

Tailor the generated content to your specific users and brand voice.

1. Select your target Audiences (End User, Power User, Administrator, or Developer).
2. Choose a General style card, such as “Precision Technical” or “Approachable Guided,” to set the tone for the entire doc set.
3. Review the Document type list. DocuBot auto-selects a preset of documents based on your chosen audiences, which you can further refine.

Expected result: The system establishes a customized plan for the types of documentation it will generate.

5. Schedule automated updates

Ensure your documentation stays synchronized with your code changes.

1. Select a Sync frequency (Daily, Weekly, or Monthly).
2. Use the Local time picker to choose when the sync should run.
3. Verify your Time zone settings to ensure the schedule aligns with your team’s operations.
4. Click Save or Create documentation site.

Expected result: A recurring synchronization job is established, and your initial documentation generation begins.

Security and access notes

As an administrator, keep the following security contexts in mind:

• GitHub OAuth permissions: DocuBot requests specific scopes to read repository content. It does not require write access to your code.
• Private repositories: Access to private repos is maintained through your GitHub token. If you revoke access in GitHub, DocuBot will no longer be able to sync those sources.
• Support configuration: Ensure your support email and portal URL are configured in your profile settings so they appear correctly in the generated “Contact and support” pages.

Next steps

Once your site is created, you can monitor the sync progress on your repository card. When the status changes to “Up to date,” click View docs to see your live documentation site.

If you encounter issues during setup, contact our support team at support@ademero.com, visit https://www.ademero.com, or call 863-937-0272.