Skip to main content

Troubleshooting

This guide covers common issues you may encounter when using Dev-Docs and how to resolve them.

VS Code Extension Issues​

Extension Not Working​

If the Dev-Docs extension is not functioning in VS Code:

  1. Ensure you are signed in to your Dev-Docs account in the extension

  2. Check that you have an active internet connection

  3. Try reloading the VS Code window (Ctrl+R or Cmd+R)

  4. Uninstall and reinstall the extension if issues persist

Cannot Generate Documentation​

If you're unable to generate documentation using the extension:

  1. Verify you have the necessary permissions in your Dev-Docs account

  2. Check your dev-docs.json configuration file for errors

  3. Ensure the files you're trying to document are saved and not in a pending state

Web App Issues​

Cannot Access Web Editor​

If you're unable to access the web editor:

  1. Clear your browser cache and cookies

  2. Try accessing from an incognito/private browsing window

  3. Verify your account has the necessary permissions

Changes Not Saving​

If changes in the web editor are not saving:

  1. Check your internet connection

  2. Ensure you're not in read-only mode

  3. Try refreshing the page and making changes again

GitHub App Integration Issues​

Workflows Not Running​

If automated workflows are not running:

  1. Check your dev-docs.json file for correct workflow configuration

  2. Ensure the GitHub App has necessary permissions on your repository

  3. Verify that your repository meets any conditions specified for workflow triggers

API Key Issues​

If you're encountering API key related errors:

  1. Regenerate your API key in the Dev-Docs dashboard

  2. Ensure the API key is correctly set in your GitHub repository secrets

  3. Check that the API key has the necessary permissions

General Troubleshooting Steps​

  1. Check the Dev-Docs status page for any ongoing service issues

  2. Review your account's usage limits and upgrade if necessary

  3. Contact Dev-Docs support if issues persist after trying these steps

Remember to keep your Dev-Docs extension, web app, and GitHub App integrations up to date for the best experience and latest features.

Dev-Docs AI Bot

Circular button