Customer StoriesReadMe Blog
Enterprise

Migrate to ReadMe

Migrating your documentation to ReadMe Enterprise is streamlined and secure. Whether you're transitioning from Docusaurus, GitBook, Mintlify, Nextra, Zendesk, or custom solutions, our enterprise platform provides the tools and support you need.

🤝

ReadMe offers Professional Services to help you migrate your content with dedicated support from our team. Please reach out to [email protected] to schedule your migration consultation.



Professional Services for Enterprise

ReadMe Enterprise includes comprehensive migration support. ReadMe partners with your team throughout the migration process, from discovery to launch:

  • Discovery session to understand your documentation architecture
  • Content audit to identify migration priorities and custom requirements
  • Automated migration of bulk content with manual review
  • QA validation to ensure content accuracy post-migration
  • Training sessions for your team


Self-Serve Migration

If you're moving from an existing docs platform, ReadMe's self-serve tools make it straightforward to bring your content over. The steps below walk you through getting your content ready to import.

Create a Project

In ReadMe, a project is a documentation site where your API references, guides, and changelogs live. It's easy to create your first one:

  1. Sign Up using your work email (recommended).
  2. Create a project for your organization.

Recommended Setup

Before importing content, here are a few ways to configure your ReadMe project to fit your team's workflow:

For our enterprise plans, you can:


Add Your Content Manually

If you’ve decided to start fresh, you can start adding content manually. It’s a good time to start new docs with intention, without any baggage or out-dated content.

If you have an OpenAPI Specification (OAS) file that defines your API, you can upload it by navigating to edit mode, and then API Reference. From there, you can provide a URL for import, or upload the file from your computer.

For all other content:

  1. Navigate to edit mode in the top navigation bar to start editing your docs
  2. Add new pages in the left-hand sidebar
  3. Add content (you can paste Markdown)

Add Your Content From Git

If you have existing documentation, syncing with Git lets you import it into ReadMe directly. Once you’ve connected your project to Git, you can upload Markdown files locally or from your Git provider. ReadMe can parse files organized like so:

📂 project
├── 📁 custom_blocks
├── 📁 custom_pages
├── 📁 docs
│   ├── 📂 category-folder
│   │   ├── 📄 page.mdx
│   │   └── 📃 _order.yaml
│   └── 📃 _order.yaml
├── 📁 recipes
└── 📁 reference

For your first import:

  • docs: Contains your main documentation content, organized in categories.
  • reference: Contains API reference documentation.

Markdown files use required frontmatter to store important information about your docs:

---
title: string # Title of the page
excerpt: string # Text displayed under title
deprecated: boolean # Mark page as deprecated
hidden: boolean # Visibility of page
category: string # Category page is organized in
metadata:
  title: string # SEO title
  description: string # SEO description
  keywords:
    - string
  robots: index | noindex # Whether this page should be indexed
  image: url

# For API Reference pages only
api:
  file: string # OAS file name ("hoot.json")
  operationId: string # Endpoint ID ("get_owls")
  webhook: boolean # If endpoint is a webhook
---

ReadMe will generate your _order.yaml files to control page order as you save changes on the platform.



Next Steps

Continue to explore ReadMe’s documentation features after you migrate your content. You can run an AI-powered Docs Audit to check the quality of your docs, create step-by-step guides for users with Recipes, see how developers are using your API with My Developers Overview and more!

📘

Reach out to [email protected] if you have any questions or need help!


Updated 22 days ago