Skip to content

For the complete documentation index, see llms.txt.

Migrate to a new docs platform

Promptless publishes to docs that live as files in a Git repository. If your hosted platform keeps your docs some other way, move the content onto a supported docs-as-code platform. Promptless can then propose changes to it. This guide covers the migration steps that every source platform shares.

A migration is a one-time project. The effort depends on how much content you have and how far your source format is from the target’s. Every platform exports differently, and the Promptless team regularly helps teams move. If you’re planning a migration, contact help@gopromptless.ai before you start.

  • Someone comfortable with Git and a static site generator, for the export, conversion, and scaffolding steps. If your docs team doesn’t write code, pair a writer with an engineer.
  • A GitHub or GitLab organization where you can create the new docs repository.
  • An admin role in your Promptless organization, to connect the repository as a doc collection.
  1. Export your content from 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. Export images and other assets with the text so links don’t break.

  2. Pick a supported platform and scaffold a new project for it in a GitHub or GitLab repository. This repository becomes the source of truth for your docs.

  3. Move the exported content into the new project’s file and folder structure, and convert it to the target’s source format and conventions.

  4. Rebuild the navigation and the frontmatter the new platform expects, such as titles, slugs, and sidebar placement.

  5. Record where every existing page lands in the new structure, as a map from each old URL to its new one.

  6. Add a redirect from each old URL to its new one, so existing links keep resolving. For both of these steps, see Preserve URLs and redirects.

  7. Once the site builds from the repository, connect the repository as a doc collection. Promptless then runs its initial analysis of your docs.

  8. Configure the triggers that keep the migrated docs current.