Migrate to a new docs platform
Teams often reach Promptless while still on a hosted platform that doesn’t expose their docs as files in a Git repository. Moving that content onto a supported docs-as-code platform is what unblocks adoption. This guide covers the migration pattern every source shares and where the source-specific work lives.
A migration is a one-time project, and the effort scales with how much content you have and how far your source format is from the target’s. The export, conversion, and scaffolding steps usually involve someone comfortable with Git and a static site generator, so plan to pair a writer with an engineer if your docs team doesn’t write code. No two platforms export the same way, and the Promptless team regularly helps teams move. If you’re planning one, reach out at help@gopromptless.ai before you start.
The migration pattern
Section titled “The migration pattern”However you export, the shape of the work is the same across source platforms:
-
Export your existing content. Pull your content out of the source platform in the most portable format it offers. Some platforms export Markdown directly; others export HTML or a proprietary format that needs a conversion pass to your target’s source format. Capture images and other assets alongside the text so links don’t break.
-
Choose and scaffold a target platform. Pick a supported platform and scaffold a new project in a GitHub repository. This repository becomes the source of truth for your docs.
-
Convert and import the content. Move the exported content into the new project’s file and folder structure, converting to the target’s source format and conventions. Rebuild the navigation and any frontmatter (titles, slugs, sidebar placement) the new platform expects.
-
Map old URLs to new ones. Record where every existing page lands in the new structure so you can preserve inbound links. See Preserve URLs and redirects for how to build and apply that mapping.
-
Connect the repository to Promptless. Once the content builds and the site is in a GitHub repository, connect it as a doc collection. From that point, Promptless keeps it current. See Doc locations & collections.
After the migration
Section titled “After the migration”With your docs in a GitHub repository on a supported platform:
- Apply your URL redirect mapping so existing links keep resolving.
- Connect the repository as a doc collection and let Promptless finish its initial analysis of your docs.
- Configure the triggers that should start keeping the migrated docs current.
Need a hand with any of this? Contact help@gopromptless.ai.