Skip to content
DocuBot documentation

Backup and recovery guide

Protect your documentation project configurations and learn how to restore your help center in the event of accidental deletion or data loss.

Overview

DocuBot generates static documentation from your code, but the specific configurations—such as your audience selections, custom scenario priorities, and known issues lists—reside within the DocuBot dashboard. Following a regular backup schedule ensures you can quickly reconstruct your documentation site with the same AI logic and structure used previously.

Backup your project

Follow these steps to create a manual backup of your documentation and its underlying configuration.

1. Export generated documentation

Ensure you have a permanent offline copy of your published content.

  1. Navigate to the Repositories page in your dashboard.
  2. Locate the repository card for your project.
  3. Click the Download PDF link.
  4. Alternatively, scroll to the footer of your live documentation site and select the PDF download option.

Expected result: A bookmarked PDF file containing your complete documentation set is saved to your local device.

2. Archive project configurations and custom inputs

Record the specific metadata and AI instructions that guide the generation process.

  1. Open the Edit settings view for your repository.
  2. Record your URL slug, Audience selections, and General style.
  3. Expand the Advanced doc inputs section.
  4. Copy and save the text from the Scenario priorities and Known issues fields to a secure document.
  5. Note the specific Document types currently active for the project.

Expected result: You have a secure record of the specific inputs required to recreate the project’s unique documentation logic.

3. Verify source repository availability

Confirm that the underlying code context is protected at the source.

  1. Visit your connected GitHub repository.
  2. Ensure the repository is active and the default branch matches the one configured in DocuBot.
  3. Verify that your organization’s standard version control backup policies are in effect for this repository.

Expected result: The source code remains accessible for future documentation synchronizations.

Recover a project

If a documentation project is deleted, use your archived data to restore the site.

1. Reconstruct the project

Recreate the documentation site using your saved configurations.

  1. Select Add repository from the dashboard.
  2. Re-enter the archived Display name and URL slug.
  3. Connect the GitHub repository source.
  4. Re-authorize GitHub access if the project involves private repositories.
  5. Paste your saved text into the Scenario priorities and Known issues fields in the Advanced doc inputs.
  6. Select the original audiences, document types, and general style.

Expected result: A new documentation project is created that matches the previous state and triggers an initial synchronization.

2. Validate the restored documentation

Confirm the recovery is successful and the output aligns with your previous version.

  1. Monitor the Sync history in the dashboard to ensure the initial generation completes without errors.
  2. Open the new live documentation site.
  3. Compare the content and structure against your most recent PDF export.

Expected result: The live site contains the expected content and follows the original formatting.

Get help

If you encounter issues during the recovery process or cannot access your source repositories, contact our support team: