Skip to content
DocuBot documentation

Migration guide

Migrating your documentation to DocuBot allows you to transform static code and API specifications into a structured, AI-powered help center. This guide walks you through the process of moving your existing documentation projects from legacy systems or manual workflows into the DocuBot platform.

Prerequisites and data safety

Before you begin the migration, ensure you have the following:

  • Access credentials: A Google account to sign in to the DocuBot dashboard and a GitHub account with read access to the target repositories.
  • Source inventory: A complete list of the GitHub repository URLs and any OpenAPI (Swagger) JSON or YAML files you intend to include.
  • Data safety: DocuBot does not modify your source code. However, keep your legacy documentation hosting active until you verify the new site is fully functional.

Migration steps

Follow these steps to transition your documentation to DocuBot.

1. Audit your existing documentation sources

Identify all repositories and API definitions that make up your current documentation. If your product is spread across multiple repositories (such as a core app and a separate API service), gather all relevant URLs.

2. Reserve your product URL slug

Sign in to the DocuBot dashboard and create a new documentation project. You must define a unique URL slug (e.g., docubot.cc/your-product-name). This slug serves as the permanent public path for your new documentation site.

3. Configure repository sources and roles

Connect your GitHub repositories as sources. If you are migrating private repositories, you must authorize DocuBot via GitHub OAuth. Assign specific roles to each source:

  • Primary UI: The main application experience.
  • API Reference: Sources containing OpenAPI or Swagger specifications.
  • Reference: Supporting repositories that provide additional context.

4. Map audiences and document types

Select the target audiences (End User, Administrator, Power User, or Developer) that align with your legacy documentation structure. DocuBot automatically suggests a document type preset based on these audiences. You can manually add or remove specific document types, such as Quick Start Guides or Troubleshooting articles, to match your previous content strategy.

5. Run an initial synchronization

Trigger a manual sync to start the AI-powered generation process. DocuBot analyzes your code and generates a static documentation site. You can monitor the progress through the sync job status indicator on your dashboard.

6. Verify content and redirect legacy links

Once the sync completes, preview your live documentation site. Check the generated pages for accuracy and ensure all interactive API references are functioning. Finally, update any external links—such as those in your application UI or marketing site—to point to the new DocuBot URL.

Rollback guidance

If you encounter issues during the migration or need to pause the transition, you can safely revert to your previous system:

  1. Maintain legacy hosting: Do not decommission your old documentation server until the DocuBot site is fully verified.
  2. Revert links: Change your application and website links back to the legacy documentation URL.
  3. Project management: You can delete the DocuBot project from the settings dashboard at any time to remove the generated content and release the reserved URL slug.

Contact support

If you need assistance during your migration, contact our support team: