Skip to content
Draft
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions migration-services/pro.mdx
Original file line number Diff line number Diff line change
@@ -1,23 +1,22 @@
---
title: "Migration services"
description: "Overview of the migration process, delivery timelines, and our quality assurance approach for Pro plans."

Check warning on line 3 in migration-services/pro.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration-services/pro.mdx#L3

Try to avoid using first-person plural like 'our'.
---

Your Pro plan includes migration services to transfer your documentation to Mintlify. This guide covers the migration process, delivery timelines, and our quality assurance approach.

Check warning on line 6 in migration-services/pro.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration-services/pro.mdx#L6

Try to avoid using first-person plural like 'our'.

## What to expect for your migration

A migration is a point-in-time transfer of your documentation that requires a code freeze. We migrate your documentation, branding (logos, colors, and fonts), and navigation structure.
A migration is a point-in-time transfer of your documentation that requires a code freeze. We migrate your documentation, branding (logos, colors, and fonts), API reference pages and navigation structure.

Check warning on line 10 in migration-services/pro.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration-services/pro.mdx#L10

Try to avoid using first-person plural like 'We'.

Check warning on line 10 in migration-services/pro.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration-services/pro.mdx#L10

Use parentheses judiciously.

Your migration includes a staging link to review progress and a 3-day feedback window after delivery to address any issues with content, assets, or branding.

<Info>
Migration services **do not** include:

Check warning on line 15 in migration-services/pro.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration-services/pro.mdx#L15

Use 'don't' instead of 'do not'.
- Dynamic syncing of your documentation
- Design or information architecture consultation
- Custom component development (landing pages, custom integrations, etc.)

Check warning on line 18 in migration-services/pro.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration-services/pro.mdx#L18

Use parentheses judiciously.
- Redirects setup
- API playground configuration
- Analytics setup
</Info>

Expand All @@ -31,45 +30,45 @@
</Step>

<Step title="Receive scoping and timeline (1-2 business days)">
We review your submission and provide an estimated delivery timeline within 24-48 hours. We'll flag any custom components or areas of your migration that need discussion.

Check warning on line 33 in migration-services/pro.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration-services/pro.mdx#L33

Try to avoid using first-person plural like 'We'.

Check warning on line 33 in migration-services/pro.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration-services/pro.mdx#L33

Try to avoid using first-person plural like 'We'.
</Step>

<Step title="Review progress during the migration">
We start the migration and share a staging link so you can monitor progress in real-time.

Check warning on line 37 in migration-services/pro.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration-services/pro.mdx#L37

Try to avoid using first-person plural like 'We'.
</Step>

<Step title="Receive final delivery">
We deliver your migration via GitHub PR or zip file based on your preference.

Check warning on line 41 in migration-services/pro.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration-services/pro.mdx#L41

Try to avoid using first-person plural like 'We'.
</Step>

<Step title="Feedback window (three business days)">
Submit any feedback on content, assets, or branding. We address all in-scope issues within the same timeframe.

Check warning on line 45 in migration-services/pro.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration-services/pro.mdx#L45

Try to avoid using first-person plural like 'We'.

Check warning on line 45 in migration-services/pro.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration-services/pro.mdx#L45

Did you really mean 'timeframe'?
</Step>

<Step title="Go-live support">
We provide documentation and guidance for connecting your repository, setting up redirects, and configuring your custom domain.

Check warning on line 49 in migration-services/pro.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration-services/pro.mdx#L49

Try to avoid using first-person plural like 'We'.
</Step>
</Steps>

## Quality assurance

We work with vetted third-party vendors and conduct an internal quality audit before delivery. Here's what we check for:

Check warning on line 55 in migration-services/pro.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration-services/pro.mdx#L55

Try to avoid using first-person plural like 'We'.

Check warning on line 55 in migration-services/pro.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration-services/pro.mdx#L55

Try to avoid using first-person plural like 'we'.

<Card title="Content completeness" icon="file-check">
- All documentation from your source has been migrated.

Check warning on line 58 in migration-services/pro.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration-services/pro.mdx#L58

In general, use active voice instead of passive voice ('been migrated').
- Content is properly formatted with Mintlify components.
- Navigation structure matches your specifications.
</Card>

<Card title="Visual elements" icon="palette">
- Images and videos display correctly.
- Custom fonts are applied throughout.

Check warning on line 65 in migration-services/pro.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration-services/pro.mdx#L65

In general, use active voice instead of passive voice ('are applied').
- Light and dark mode logos are used appropriately.

Check warning on line 66 in migration-services/pro.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration-services/pro.mdx#L66

In general, use active voice instead of passive voice ('are used').
- Color schemes meet contrast requirements in both modes.
</Card>

<Card title="Functionality" icon="rocket">
- All links work correctly (no broken links).

Check warning on line 71 in migration-services/pro.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration-services/pro.mdx#L71

Use parentheses judiciously.
- Table of contents renders properly.
- React components function as expected.
- No performance issues.
Expand All @@ -77,32 +76,32 @@

## After your migration

Once we deliver your migration, you'll need to complete the following steps to launch your documentation:

Check warning on line 79 in migration-services/pro.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration-services/pro.mdx#L79

Try to avoid using first-person plural like 'we'.

1. [Connect your GitHub repository and get setup](https://www.mintlify.com/docs/quickstart#install-the-github-app).
2. [Set up redirects if required](https://www.mintlify.com/docs/create/redirects).
3. [Configure your custom domain](https://www.mintlify.com/docs/customize/custom-domain).
4. **Test before going live** - Before switching over from your old documentation:
- Review all pages on your staging link.
- Test navigation and search functionality.

Check warning on line 86 in migration-services/pro.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration-services/pro.mdx#L86

Use 'capability' or 'feature' instead of 'functionality'.
- Verify all images and videos load correctly.
- Check that code blocks render properly.
- Test on mobile and desktop.
5. **Launch!** Your documentation is ready to go live!

Check warning on line 90 in migration-services/pro.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration-services/pro.mdx#L90

Don't use exclamation points in text.

<Note>
**Need help?** Our support team is available to guide you through these steps. Reach out via [[email protected]](mailto:[email protected]).

Check warning on line 93 in migration-services/pro.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration-services/pro.mdx#L93

Try to avoid using first-person plural like 'Our'.
</Note>

## Frequently asked questions

<AccordionGroup>
<Accordion title="How long does a migration take?">
We typically deliver migrations within 10 business days, depending on complexity. You'll receive a specific timeline within 24-48 hours of submitting your migration form.

Check warning on line 100 in migration-services/pro.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration-services/pro.mdx#L100

Try to avoid using first-person plural like 'We'.
</Accordion>

<Accordion title="Can I request changes after delivery?">
Yes. You have a 3-day feedback window after delivery to request changes to content, assets, or branding. We address all in-scope feedback within the same timeframe.

Check warning on line 104 in migration-services/pro.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration-services/pro.mdx#L104

Try to avoid using first-person plural like 'We'.

Check warning on line 104 in migration-services/pro.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration-services/pro.mdx#L104

Did you really mean 'timeframe'?
</Accordion>

<Accordion title="What do I need to do after the migration is complete?">
Expand All @@ -115,10 +114,10 @@
</Accordion>

<Accordion title="Can I customize the navigation structure?">
Yes. You can provide a custom information architecture in the migration form, and we'll implement it. However, custom component development (like custom landing pages) is not included in the migration service.

Check warning on line 117 in migration-services/pro.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration-services/pro.mdx#L117

Try to avoid using first-person plural like 'we'.

Check warning on line 117 in migration-services/pro.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration-services/pro.mdx#L117

Use parentheses judiciously.

Check warning on line 117 in migration-services/pro.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration-services/pro.mdx#L117

Use 'isn't' instead of 'is not'.
</Accordion>

<Accordion title="What happens if my documentation changes during the migration?">
Since migrations require a code freeze, any changes made to your source documentation after submission won't be included. We recommend completing all updates before starting the migration.

Check warning on line 121 in migration-services/pro.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration-services/pro.mdx#L121

In general, use active voice instead of passive voice ('be included').

Check warning on line 121 in migration-services/pro.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration-services/pro.mdx#L121

Try to avoid using first-person plural like 'We'.
</Accordion>
</AccordionGroup>