Skip to content
DocuBot documentation

Migration guide

This guide helps you transition your existing documentation workflow from a legacy system to DocuBot’s automated platform.

Audit existing documentation

Identify which of your legacy documents map to DocuBot’s audience-based framework. Categorize your current help articles by target audience, such as End User, Administrator, or Developer. This categorization allows you to select the correct document types during the setup process in the DocuBot dashboard.

Prepare repository sources

Ensure all source code and OpenAPI specifications are available in your GitHub repositories. DocuBot requires access to these sources to generate accurate, code-aligned documentation. Verify your GitHub connection status in the workspace settings to ensure DocuBot can retrieve the necessary context for AI generation.

Configure the DocuBot workspace

Create a new documentation site within your dashboard. You must define a display name and a unique public URL slug. The slug determines the web address where your documentation will live (for example, docubot.cc/your-product). Once configured, your workspace is ready for its first synchronization.

Execute initial synchronization

Trigger the first build to generate your new documentation set. The system processes your repository sources and publishes the first version of your static site. You can monitor the progress through the sync status indicator and verify completion by checking the last sync timestamp on your repository card.

Validate generated output

Review the generated pages and PDF exports for accuracy and style consistency. Use the “View docs” button to browse the live site and the PDF export link to check the formatted document. Ensure the content matches your selected general style and that all technical details are correctly represented.

Redirect your users from legacy documentation URLs to the new DocuBot site. Use your reserved public URL slug to point users toward the new SEO-friendly routes. If you have integrated API references, ensure your developer links point to the new interactive API reference pages.

Rollback guidance

If you need to delay your migration or revert to your legacy system, you can disable the automated sync schedule in the repository settings. To completely remove the new documentation from public view, you may delete the URL slug associated with the project.

If you encounter issues during your migration, contact support through the following channels: