Error code reference
Overview
DocuBot provides descriptive error messages in the dashboard to help you identify and resolve issues with your documentation projects. You’ll typically see these messages on repository cards under the Last sync status or as validation alerts when you’re creating or editing a project.
Repository and slug errors
These errors occur when there’s a problem with your project configuration or the public URL you’ve chosen.
| Error message | Cause | Resolution |
|---|---|---|
| That slug is already in use | The URL slug you entered is already reserved by another DocuBot project. | Choose a unique slug for your documentation site. |
| Slug is invalid | The slug contains unsupported characters like uppercase letters, spaces, or symbols. | Ensure your slug only uses lowercase letters, numbers, and dashes. |
| Repository not found or access denied | DocuBot can’t reach the GitHub repository. This often happens if the URL is mistyped or the repo is private. | Verify the repository URL. If the repo is private, ensure you’ve connected your GitHub account in Settings. |
GitHub integration errors
These errors relate to the connection between DocuBot and your GitHub account.
| Error message | Cause | Resolution |
|---|---|---|
| GitHub authorization required for private repositories | You’re trying to add or sync a private repository without an active GitHub connection. | Go to Settings and click Connect GitHub to authorize access. |
| OAuth state expired. Please retry | The security token for your GitHub connection attempt timed out (usually after 15 minutes). | Restart the GitHub connection process from your Settings page. |
| GitHub token exchange failed | There was a communication issue between DocuBot and GitHub during authorization. | Check your internet connection and try connecting your account again. |
Synchronization 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 refreshes. | Wait 24 hours for the limit to reset or rely on your scheduled daily sync. |
| A sync is already running for this repo | You’ve requested a manual sync while a scheduled or previous manual sync is still active. | Wait for the current sync job to finish before requesting another. |
| Repository context too large for processing | Your repository contains too much data for the AI to analyze in a single pass. | Use Ignore patterns in your repository settings to exclude large, non-essential directories like third-party libraries. |
| OpenAPI specification parsing failures | DocuBot found an API file but couldn’t read it correctly. | Ensure your OpenAPI or Swagger files are valid JSON or YAML and follow standard specifications. |
Account and permission errors
These errors are related to your subscription level or user permissions.
| Error message | Cause | Resolution |
|---|---|---|
| Free accounts can only track one repository | You’ve reached the limit for the free tier. | Remove your existing repository before adding a new one, or upgrade to a paid account. |
| Monthly syncs are available on free accounts | You’ve tried to set a daily or weekly schedule on a free tier account. | Set your sync frequency to Monthly or upgrade your account to unlock more frequent updates. |
| Unauthorized access to repository settings | You’re attempting to edit a repository that you don’t own. | Ensure you’re signed in with the correct Google account associated with the project. |
Contacting support
If you encounter an error that isn’t listed here or if the suggested resolution doesn’t work, please reach out to our support team.
- Email: support@ademero.com
- Support Portal: https://www.ademero.com
- Phone: 863-937-0272
When contacting support, please include the name of your repository and the exact error message displayed in your dashboard.