Error code reference
This reference guide helps you identify and resolve common errors encountered while configuring your workspace, connecting repositories, or synchronizing documentation.
Authentication and access errors
These errors typically occur when connecting your Google account or authorizing DocuBot to access your GitHub repositories.
| Error message | Cause | Resolution |
|---|---|---|
| Invalid OAuth state | The authentication session timed out or the security token expired. | Restart the connection process from your profile or settings page. Ensure you complete the GitHub authorization within 15 minutes. |
| GitHub authorization required | You’re attempting to add or sync a private repository without an active GitHub connection. | Go to Settings and click Connect GitHub to authorize access to your private repositories. |
| Unable to verify user | The system couldn’t confirm your account details during the sign-in process. | Sign out and sign back in using your Google account. Ensure your email is verified. |
Repository configuration errors
Use this section to resolve issues related to setting up a new documentation site or modifying existing repository sources.
| Error message | Cause | Resolution |
|---|---|---|
| That slug is already in use | The URL slug you chose is already taken by another documentation site. | Choose a unique slug using lowercase letters, numbers, and dashes. |
| Invalid repo URL | The provided URL isn’t a valid GitHub repository link. | Verify the URL in your browser. It must follow the format https://github.com/owner/repo. |
| Free accounts can only track one repository | You’ve reached the project limit for the free tier. | Upgrade to a paid plan to add more repositories, or delete your existing repository before adding a new one. |
| Unknown repo role selected | The manually assigned role for a repository source is invalid. | Select one of the standard roles: Primary UI, UI app, API reference, or Reference only. |
Sync and generation errors
These errors occur during the automated or manual process of turning your code into documentation.
| Error message | Cause | Resolution |
|---|---|---|
| Manual sync limit reached for today | You’ve exceeded the daily limit for manual documentation rebuilds. | Wait for your next scheduled daily sync or try again tomorrow. |
| A sync is already running for this repo | A documentation build is currently in progress for this project. | Wait for the active sync to finish. You can monitor the progress on the repository card in your dashboard. |
| Repository context is too large | The repository contains too much data for the AI engine to process in one pass. | Reduce the number of files by ignoring non-essential directories or contact support for high-capacity processing. |
| Doc generation failed | An internal error occurred during the AI writing or site building phase. | Check that your repository is still accessible and contains valid source code, then try a manual rebuild. |
Interactive API reference errors
Troubleshoot issues related to the ingestion of OpenAPI specifications and the rendering of interactive API viewers.
| Error message | Cause | Resolution |
|---|---|---|
| OpenAPI file not detected | The system couldn’t find a valid OpenAPI or Swagger specification in the repository. | Ensure your specification file is in JSON or YAML format and includes the openapi: or swagger: version tag. |
| Scalar API viewer failed to load | The interactive documentation component couldn’t retrieve the specification file. | Verify that the specification file is valid and accessible within your repository. Check your browser console for connectivity issues. |
Contacting support
If you encounter an error not listed here or cannot resolve an issue using the steps provided, please reach out to our support team for assistance.
- Email: support@ademero.com
- Support Portal: https://www.ademero.com
- Phone: 863-937-0272
When contacting support, please include the repository name, the specific error message you received, and the time the error occurred.