Skip to content
Merged
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
122 changes: 122 additions & 0 deletions migration-services/custom.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,122 @@
---
title: "Custom plan migrations"
description: "Overview of the full-service migration process, delivery timelines, and our quality assurance approach for Custom plans."

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration-services/custom.mdx#L3

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

You can choose our 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/custom.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration-services/custom.mdx#L6

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

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration-services/custom.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, API reference pages, branding (logos, colors, and fonts), and navigation structure. Migration services also include design or information architecture consultation and custom component development such as landing pages or custom integrations.

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration-services/custom.mdx#L10

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

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration-services/custom.mdx#L10

Use parentheses judiciously.

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

## Migration process

The migration process is highly collaborative. We work closely with your team to implement custom solutions and builds that work for you!

Check warning on line 16 in migration-services/custom.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration-services/custom.mdx#L16

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

Check warning on line 16 in migration-services/custom.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration-services/custom.mdx#L16

Don't use exclamation points in text.

<Steps>
<Step title="Submit the migration form">
Submit the [migration form](https://mintlify.typeform.com/pro-migrations).

Provide your documentation source, brand assets (logos, color codes, fonts), OpenAPI specs, go-live date, and preferred delivery method (GitHub PR or zip file).
</Step>

<Step title="Kick-off call">
We review your submission and lead a kick-off call with our migration team to walk through your current setup, understand any limitations, and address any questions your team might have.

Check warning on line 26 in migration-services/custom.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration-services/custom.mdx#L26

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

Check warning on line 26 in migration-services/custom.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration-services/custom.mdx#L26

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

<Step title="Receive scoping and timeline (1-2 business days)">
We review and analyze the context from the call 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 30 in migration-services/custom.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration-services/custom.mdx#L30

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

Check warning on line 30 in migration-services/custom.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration-services/custom.mdx#L30

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 34 in migration-services/custom.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration-services/custom.mdx#L34

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 38 in migration-services/custom.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration-services/custom.mdx#L38

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

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

Check warning on line 42 in migration-services/custom.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration-services/custom.mdx#L42

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

Check warning on line 42 in migration-services/custom.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration-services/custom.mdx#L42

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 46 in migration-services/custom.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration-services/custom.mdx#L46

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 52 in migration-services/custom.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration-services/custom.mdx#L52

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

Check warning on line 52 in migration-services/custom.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration-services/custom.mdx#L52

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 55 in migration-services/custom.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration-services/custom.mdx#L55

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 62 in migration-services/custom.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration-services/custom.mdx#L62

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

Check warning on line 63 in migration-services/custom.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration-services/custom.mdx#L63

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 68 in migration-services/custom.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration-services/custom.mdx#L68

Use parentheses judiciously.
- Table of contents renders properly.
- React components function as expected.
- No performance issues.
</Card>

## After your migration

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

Check warning on line 76 in migration-services/custom.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration-services/custom.mdx#L76

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

1. [Connect your GitHub repository and get setup](/quickstart#install-the-github-app).
2. [Set up redirects, if required](/create/redirects).
3. [Configure your custom domain](/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 83 in migration-services/custom.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration-services/custom.mdx#L83

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 87 in migration-services/custom.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration-services/custom.mdx#L87

Don't use exclamation points in text.

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

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration-services/custom.mdx#L90

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 2-6 weeks, depending on complexity. You'll receive a specific timeline after the kick-off call.

Check warning on line 97 in migration-services/custom.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration-services/custom.mdx#L97

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

<Accordion title="Can I request changes after delivery?">
Yes. You have a 7-day feedback window after delivery to request changes to content, assets, or branding. We address all in-scope feedback within the same timeframe and work with you right until you are ready to go live.

Check warning on line 101 in migration-services/custom.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration-services/custom.mdx#L101

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

Check warning on line 101 in migration-services/custom.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration-services/custom.mdx#L101

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

<Accordion title="What do I need to do after the migration is complete?">
The migration transfers your content, but you'll need to:
- Connect your documentation repository to your Mintlify dashboard.
- Set up redirects from your old documentation URLs.
- Configure your custom domain.

We provide step-by-step documentation and support for each of these steps.

Check warning on line 110 in migration-services/custom.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration-services/custom.mdx#L110

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

<Accordion title="Can I customize the navigation structure?">
Yes. You can provide a custom information architecture and we will implement it. We also work with you on custom component development if that is needed and supported by the platform.

Check warning on line 114 in migration-services/custom.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration-services/custom.mdx#L114

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

Check warning on line 114 in migration-services/custom.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration-services/custom.mdx#L114

Avoid using 'will'.

Check warning on line 114 in migration-services/custom.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration-services/custom.mdx#L114

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

Check warning on line 114 in migration-services/custom.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration-services/custom.mdx#L114

Use 'that's' instead of 'that is'.

Check warning on line 114 in migration-services/custom.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration-services/custom.mdx#L114

In general, use active voice instead of passive voice ('is needed').
</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 118 in migration-services/custom.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration-services/custom.mdx#L118

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

Check warning on line 118 in migration-services/custom.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration-services/custom.mdx#L118

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

If this is not possible, our team will work with you to set short sprints to migrate certain sections or reserve dedicated time post the first sprint to migrate the delta changes made during the migration.

Check warning on line 120 in migration-services/custom.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration-services/custom.mdx#L120

Use 'isn't' instead of 'is not'.

Check warning on line 120 in migration-services/custom.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration-services/custom.mdx#L120

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

Check warning on line 120 in migration-services/custom.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration-services/custom.mdx#L120

Avoid using 'will'.
</Accordion>
</AccordionGroup>