Will someone help with the move?

Yes. Book a call and a founder will go through your project with you and help the first release over by hand. Questions also reach us at founders@octri.dev.

Migration guide

Migrate from ReadMe to Octri

The move starts from two things a ReadMe project already has: the OpenAPI file its reference is built from and, with bi-directional sync, its pages as Markdown in Git.

Start on the Free plan Book a call

Written by Octri · Checked 25 October 2026

What to have to hand

Your OpenAPI file, and your Markdown in a GitHub repository. Everything else is set in API Studio and SDK Studio.

openapi.json
Markdown from bi-directional sync

What comes across

ReadMe has no config for Octri to read, so the move runs on files you already have. Rows marked “By hand” are what is left for you.

What	In Octri	From ReadMe
API reference	A page for every endpoint, written for you	Your OpenAPI file
Guides	Page drafts, by Pull from GitHub	Markdown from bi-directional sync
Redirects	octri.json	Your ReadMe redirects, by hand
Logo, colours and fonts	Set in API Studio	By hand
SDKs	Generated in the languages you pick	Nothing to bring

Step by step

Bring the spec
Sign up and upload the OpenAPI file your ReadMe reference is built from, or connect the repository it lives in. Octri writes a reference page for every endpoint, with the playground, search and chat switched on.
Pull your guides from GitHub
Connect the repository that holds the Markdown that ReadMe’s bi-directional sync writes, then choose Pull from GitHub in the API Studio Files panel. Pick up to 50 Markdown or MDX files at a time and each lands as a page draft, with its title, description, icon and badge taken from the frontmatter. Switch on sync on push and later edits in Git keep landing on the same pages.
Swap ReadMe’s blocks
ReadMe’s own callout and embed blocks become Octri components such as <Callout>, <Tabs> and <Frame>. The page preview shows each one as you change it.
Set up your SDKs
Pick your languages in SDK Studio, and the call through each SDK appears on every endpoint page. Give each language the package name your users already install, and publish the first Octri release as a new major version, since method names and types can change. Every later spec change arrives in the SDK repository as a pull request.
Keep your old links working
Open octri.json in the Files panel and add a redirect for each old path. A rule that ends in /* covers a whole section, and a project keeps up to 500 of them.
Go live
Publish, then point your custom domain at Octri last, so readers keep the old site until the new one is ready. From then on every merged spec change rebuilds the draft of your docs, SDKs and MCP tools, ready for you to publish.

Questions

No. The importer only reads the files you upload, and Pull from GitHub only reads your repository. Nothing is written back to either, so your current site keeps running until you move the domain.