---
title: "From Mintlify"
description: "Migrate Mintlify MDX, docs.json navigation, components, OpenAPI, and hosted integrations"
canonical_url: "https://docs.farming-labs.dev/docs/migrations/mintlify"
markdown_url: "https://docs.farming-labs.dev/docs/migrations/mintlify.md"
last_updated: "2018-10-20"
agent:
  tokenBudget: 1550
  task: "Migrate a Mintlify documentation repository into Farming Labs Docs."
  outcome: "Mintlify MDX, navigation, assets, and supported components render in a buildable Farming Labs Docs project."
  appliesTo:
    framework:
      - "nextjs"
      - "tanstackstart"
      - "sveltekit"
      - "astro"
      - "nuxt"
    version:
      - ">=0.2.60"
    package:
      - "@farming-labs/docs"
  prerequisites:
    - "Obtain the Git repository containing docs.json or mint.json, all MDX pages, assets, snippets, and OpenAPI files."
    - "Record hosted redirects, authentication, analytics, custom domains, and dashboard-only settings."
    - "Initialize the target runtime separately from the source deployment."
  files:
    - "docs.json"
    - "mint.json"
    - "docs.config.ts"
    - "docs.config.tsx"
  commands:
    - run: "npx @farming-labs/docs init"
      description: "Scaffold the target docs runtime before moving Mintlify content."
  sideEffects:
    - "Mintlify navigation and components are converted to Farming Labs file structure and MDX components."
  verification:
    - description: "Build the target and compare navigation, components, assets, API pages, redirects, and protected content."
      expect: "The build passes and all required public routes and Markdown routes resolve."
  rollback:
    - "Leave the Mintlify production project connected until the new deployment and redirects pass verification."
  failureModes:
    - symptom: "A Mintlify component is undefined during MDX compilation."
      resolution: "Replace it with the mapped Farming Labs component or register an equivalent custom component."
    - symptom: "A setting exists only in the Mintlify dashboard."
      resolution: "Record the behavior and recreate it explicitly in application, hosting, or Farming Labs configuration."
---

<!-- farming-labs:agent-contract:start -->
## Agent Contract

Task: Migrate a Mintlify documentation repository into Farming Labs Docs.
Outcome: Mintlify MDX, navigation, assets, and supported components render in a buildable Farming Labs Docs project.

### Applies To

- Framework: `nextjs`, `tanstackstart`, `sveltekit`, `astro`, `nuxt`
- Version: `>=0.2.60`
- Package: `@farming-labs/docs`

### Prerequisites

- Obtain the Git repository containing docs.json or mint.json, all MDX pages, assets, snippets, and OpenAPI files.
- Record hosted redirects, authentication, analytics, custom domains, and dashboard-only settings.
- Initialize the target runtime separately from the source deployment.

### Files

- `docs.json`
- `mint.json`
- `docs.config.ts`
- `docs.config.tsx`

### Commands

- `npx @farming-labs/docs init` — Scaffold the target docs runtime before moving Mintlify content.

### Side Effects

- Mintlify navigation and components are converted to Farming Labs file structure and MDX components.

### Verification

- Build the target and compare navigation, components, assets, API pages, redirects, and protected content.
  - Expected: The build passes and all required public routes and Markdown routes resolve.

### Rollback

- Leave the Mintlify production project connected until the new deployment and redirects pass verification.

### Failure Modes

- A Mintlify component is undefined during MDX compilation. — Recovery: Replace it with the mapped Farming Labs component or register an equivalent custom component.
- A setting exists only in the Mintlify dashboard. — Recovery: Record the behavior and recreate it explicitly in application, hosting, or Farming Labs configuration.
<!-- farming-labs:agent-contract:end -->

# From Mintlify

## From Mintlify task

Task: Migrate a Mintlify documentation repository into Farming Labs Docs.

Expected result: Mintlify MDX, navigation, assets, and supported components render in a buildable Farming Labs Docs project.

## From Mintlify prerequisites

- Obtain the Git repository containing docs.json or mint.json, all MDX pages, assets, snippets, and OpenAPI files.
- Record hosted redirects, authentication, analytics, custom domains, and dashboard-only settings.
- Initialize the target runtime separately from the source deployment.
- Applies to framework nextjs, tanstackstart, sveltekit, astro, nuxt; version >=0.2.60; package @farming-labs/docs.

## From Mintlify verification

- Build the target and compare navigation, components, assets, API pages, redirects, and protected content. Expected: The build passes and all required public routes and Markdown routes resolve.
- Failure: A Mintlify component is undefined during MDX compilation.
- Recovery: Replace it with the mapped Farming Labs component or register an equivalent custom component.
- Rollback: Leave the Mintlify production project connected until the new deployment and redirects pass verification.

## From Mintlify agent guidance

Read docs.json or mint.json before moving pages. Preserve the exact navigation arrays, page paths,
OpenAPI sources, redirects, and integrations in a migration inventory. Do not assume a dashboard
setting exists in the repository; require the user to confirm authentication, custom domains,
analytics, preview behavior, and protected content before cutover.

## Sitemap

See the full [sitemap](/sitemap.md) for all pages.
Docs-scoped sitemap: [/docs/sitemap.md](/docs/sitemap.md).
Well-known sitemap: [/.well-known/sitemap.md](/.well-known/sitemap.md).
