📦 Migration: Moving Your Docs to Their New Home

With our documentation migration tool, we've made it super simple to bring your existing documentation into ReadMe. Whether you're coming from Docusaurus, GitBook, Mintlify, Nextra, or Zendesk, we've got you covered. Let's walk through the process of giving your docs an awesome new home.

Before You Begin

Here's what you'll need to have ready:

• The URL of your current documentation
• Access to your existing documentation platform
• Your ReadMe account (if you don't have one yet, you can sign up at readme.com)

🔄 Migration Process

Step 1: Access the Migration Tool

Head over to our migration portal at MrScraper x ReadMe. This is your gateway to seamless documentation migration.

Step 2: Fill Out Your Details

Let's get you set up:

1. Enter your name and email address - we'll use these to keep you updated on your migration progress
2. Select your current documentation platform from the options:
   • Docusaurus
   • GitBook
   • Mintlify
   • Nextra
   • Zendesk

Step 3: Provide Your Documentation URL

Enter the full URL of your current documentation (e.g., https://docs.yourdomain.com). Make sure this URL points to the root of your documentation.

Step 4: Specify Version Information

If you're using version control in your current documentation:

• Enter your version number in the format v2.0 or v2.1.0-beta
• This helps ensure your versioned content migrates correctly

Step 5: Initiate Migration

Click the "Submit" button to start the migration process. Our tool will:

• Analyze your existing documentation structure
• Convert your content to ReadMe's MDX format
• Preserve your documentation hierarchy
• Maintain your existing content relationships

🎯 What Gets Migrated

Our migration tool handles:

• All documentation pages and their content
• Images and other media files
• Code blocks and syntax highlighting
• Headers and navigation structure
• Links between pages
• Custom HTML and CSS (where applicable)

📝 Post-Migration Steps

After the migration completes:

1. Review your migrated content in ReadMe
2. Verify all links are working correctly
3. Check that your code samples are properly formatted
4. Update any platform-specific features to use ReadMe equivalents
5. Take advantage of ReadMe's MDX capabilities to enhance your docs

⚡ Best Practices

• Clean Up First: Before migrating, consider cleaning up your existing documentation
• Test Run: If possible, do a test migration with a small section first
• Backup: Always keep a backup of your original documentation
• Review: Plan time for post-migration review and adjustments
• Enhance: Look for opportunities to improve your docs using ReadMe's features

🎉 What's Next?

Once your content is migrated, you'll have access to all of ReadMe's powerful features:

• Interactive API documentation
• Developer metrics and insights
• Customizable landing pages
• Bi-directional Git sync
• MDX support for dynamic content
• And much more!

Remember, migration is just the beginning. With ReadMe, you're setting yourself up for documentation success with tools that grow with your API.