Skip to content
DocuBot documentation

Backup and recovery guide

You can protect your documentation configurations and restore your site if you encounter configuration errors or data loss. This guide helps you manage your documentation backups and perform a full recovery.

Identify your data scope

Understand where your data lives to ensure you have a complete backup strategy. DocuBot documentation relies on two distinct data sources:

  • Source Content: Your primary documentation content is stored within your GitHub repositories. As long as your code exists in GitHub, your source content is safe.
  • Site Configuration: Your workspace settings, including selected audiences, document types, and custom scenario focuses, are managed within the DocuBot dashboard.

Export documentation as PDF

Create a point-in-time backup of your generated documentation to keep a portable record of your help center.

  1. Open your repository list in the DocuBot dashboard.
  2. Locate the repository you want to back up.
  3. Click Download PDF on the repository detail card.
  4. Save the generated file to a secure local or cloud storage location.

You can also find this export link in the footer of your live documentation site.

Document your site configuration

Keep a record of your specific site settings to make manual restoration easier if a project is accidentally deleted.

  1. Navigate to the Edit settings page for your repository.
  2. Note your selected Audiences and Document types.
  3. Copy any text from the Scenario priorities and Known issues & workarounds sections in the Advanced doc inputs area.
  4. Store these details in a secure internal document.

Restore repository connections

If your documentation stops updating due to a connection failure, you must re-authorize your GitHub access.

  1. Go to the Settings page in your workspace.
  2. Check the GitHub connection status.
  3. If the status is not “Connected,” click Connect GitHub.
  4. Follow the authorization flow to restore access to your repositories.

Trigger a recovery rebuild

Once your connections are restored, you can force the system to regenerate your entire documentation site.

  1. Return to the Repositories page.
  2. Locate the project you need to restore.
  3. Click Rebuild documentation.
  4. Monitor the Syncing now progress indicator to ensure the process completes.

Verify the restored site

Confirm that your documentation is back online and reflects the latest code.

  1. Check the Last sync status on your repository card; it should display “Up to date.”
  2. Click View docs to open your live site.
  3. Navigate through a few pages to verify that the content is loading correctly at your public URL slug.

Get help

If you are unable to restore your site or need assistance with a configuration error, contact support: