Skip to content
DocuBot documentation

First admin user setup

You establish administrative access to DocuBot to manage documentation projects, configure workspace settings, and connect your source code repositories. This setup ensures your documentation environment is ready to generate and publish static help centers.

1. Sign in with Google

DocuBot uses Google for identity management. You do not need to create a separate password for the platform.

  1. Navigate to the DocuBot landing page.
  2. Click the Sign in button.
  3. Select your Google account and follow the authentication prompts.
  4. Verify that you are redirected to the DocuBot management dashboard.

2. Authorize GitHub access

To analyze your code and generate documentation, DocuBot requires access to your GitHub account. This is mandatory if you intend to document private repositories.

  1. Go to the Settings or Profile section in the sidebar.
  2. Locate the GitHub connection area.
  3. Click Connect GitHub.
  4. Authorize the DocuBot application through the GitHub OAuth prompt.
  5. Confirm that your GitHub username appears as Connected in your settings.

3. Configure workspace preferences

Setting your workspace preferences ensures that documentation sync schedules align with your local time and that your published docs contain the correct contact information.

  1. Open the Settings page.
  2. Under Scheduling, select your Preferred time zone from the dropdown menu.
  3. Under Support contacts, enter your support email, phone number, and portal URL.
  4. Click Save settings.
  5. Verify the Preview shows the correct local time for your zone.

4. Create your first documentation project

Once your account is configured, you can initialize your first documentation site.

  1. Click Add repository in the sidebar.
  2. Enter a Display name for the project.
  3. Enter a unique URL slug. This becomes the public address for your docs (e.g., docubot.cc/your-slug).
  4. Provide the GitHub repository URL for your source code.
  5. Click Create documentation site.
  6. Confirm the project appears in your repository list with a Queued or Syncing status.

Security and access notes

DocuBot prioritizes the security of your repository access and administrative credentials.

  • Credential Storage: DocuBot does not store your Google or GitHub passwords. Authentication and token management are handled through secure OAuth providers.
  • Repository Permissions: You can add public repositories without a GitHub connection. However, private repositories require an active GitHub authorization to allow the generator to read your code.
  • Access Control: Administrative access is tied to your verified email address. Ensure your Google account is secured with multi-factor authentication for maximum workspace security.

Administrative support

If you encounter issues during the initial setup or repository connection, contact the support team for assistance.