Skip to content
DocuBot documentation

Troubleshooting guide

This guide helps you identify and resolve common issues with repository connectivity, documentation synchronization, and site publishing. Follow these steps to return your documentation site to a healthy state.

GitHub connection and access issues

If you can’t see your private repositories or receive an “Access Denied” error, your GitHub authorization is likely missing or expired.

  1. Navigate to the Settings page in your DocuBot workspace.
  2. Locate the GitHub connection section to verify your status.
  3. Click Connect GitHub if the status shows “Not connected” or if you need to refresh your permissions.
  4. Confirm that the repository visibility settings on GitHub allow DocuBot to read the content.

Synchronization failures

When a repository card displays a “Failed” status, the automated documentation generation process has stopped.

  1. Open the Repositories tab in your dashboard.
  2. Find the affected repository and read the specific error message displayed on the card.
  3. Click Rebuild documentation to trigger a manual sync and see if the issue resolves.
  4. Verify that the repository URL is still valid and that the default branch has not been deleted or renamed.

Missing API references

If your OpenAPI or Swagger specifications do not appear in the documentation sidebar, check your document type and role settings.

  1. Click Edit settings on the repository card.
  2. Scroll to the Document types section and ensure API Reference is selected.
  3. Check the Repository sources section and confirm the role is set to API reference or Auto detect.
  4. Ensure your specification files are in a supported format (JSON or YAML) and are located within the connected repository.

URL slug and publishing errors

If your documentation site fails to load at the expected address or you encounter a slug conflict, verify your configuration.

  1. Open the repository settings and locate the URL slug field.
  2. Click the Live URL preview link to confirm the exact public web address.
  3. Ensure the slug follows the required format: lowercase letters, numbers, and dashes only.
  4. If you receive a conflict error, choose a different, unique slug that isn’t already in use by another project.

Contacting support

If the steps above don’t resolve your issue, reach out to our support team for further assistance.

When contacting support, include your repository slug and any specific error messages displayed in your workspace.