Migration guideMigrate from ReadMe

Migrate from ReadMe

See what moves when you migrate a ReadMe project to Documentation.AI, and what you decide along the way.

You can migrate a ReadMe project from its sync repository, through the ReadMe API, or from its live site. The steps are the same as for every platform. See Migrate to Documentation.AI.

What you can migrate from

  • Your sync repository, with categories as folders under docs. Tell your assistant the folder where you cloned it.
  • The ReadMe API. Create a ReadMe API key, and set it as the README_API_KEY environment variable before you start your assistant. The migrator cannot yet prove by itself that the API listed every page, so this path does not pass the final release check; the sync repository does.
  • Your live site, such as https://acme.readme.io.

What moves

In ReadMeIn Documentation.AI
CategoriesSidebar groups
Page order and child pagesThe same order and nesting
Callout blockquotes, such as 📘, 👍, 🚧, and ❗Callout with the matching style
AccordionsExpandable
Cards and columnsCard and Columns
TabsTabs
EmbedsEmbedded frames
Recipes that include their stepsSteps
ImagesImages in your media library

Pages marked as hidden in ReadMe are not migrated. The report lists them.

What needs your decision

At the second decision, your assistant shows each of these with the pages that use it:

  • Variables and glossary terms
  • Recipes without their steps
  • Components from the ReadMe marketplace

What does not move

  • API reference generated from an OpenAPI file uploaded to ReadMe. Export the file from ReadMe and import it into Documentation.AI. See OpenAPI Import.
  • Changelog posts. Recreate them with the Update component.
  • Your footer, custom fonts, and banner. See What does not move.

Migrate to Documentation.AI

The steps and decisions of a migration.

OpenAPI Import

Build endpoint pages from your specification.

Was this page helpful?