Migrar desde ReadMe

mkdir mintlify-migration
cd mintlify-migration
npx @mintlify/scraping@latest section https://your-project.readme.io

npx @mintlify/scraping@latest section https://your-project.readme.io --filter=/docs

docs/             Guías organizadas por categoría
reference/        Páginas de referencia de API y archivos OpenAPI
recipes/          Recetas paso a paso
custom_pages/     Páginas personalizadas en Markdown o HTML
custom_blocks/    Bloques personalizados reutilizables
_order.yaml       Orden dentro de una carpeta o categoría

• Callouts, pestañas, acordeones, tarjetas y grupos de código
• Contenido reutilizable y bloques personalizados
• Variables y términos del glosario
• Recetas interactivas
• Páginas HTML personalizadas
• Exploradores de API integrados y contenido personalizado

1. Encuentra cada archivo OpenAPI en JSON o YAML en reference/ y en cualquier repositorio fuente que hayas usado con rdme o con la sincronización de API de ReadMe.
2. Identifica el Markdown que los editores añadieron en ReadMe fuera de la especificación. ReadMe asocia este contenido con una operación por su operationId.
3. Añade la especificación a tu repositorio de Mintlify y configura las páginas generadas a partir de OpenAPI.
4. Traslada el Markdown complementario valioso a la descripción de la operación correspondiente, la descripción del esquema o una guía adyacente.
5. Compara la autenticación, las URL de servidor, los ejemplos de código, los ejemplos y el orden de los endpoints con tu referencia original.

• Una versión predeterminada distinta y su comportamiento de URL
• Versiones ocultas, beta y obsoletas
• Contenido reutilizable específico de una versión
• Páginas que existen solo en una versión
• Especificaciones de API que difieren según la versión
• Páginas personalizadas o contenido de changelog compartidos

• URL de la versión predeterminada que omiten el segmento de versión
• Páginas personalizadas bajo /page
• Guías y páginas de referencia con el mismo slug
• Rutas de endpoint derivadas de las etiquetas y resúmenes de OpenAPI
• Páginas obsoletas u ocultas que aún reciben tráfico

​

Lanza tu nuevo sitio

• Establece una congelación de contenido en tu sitio anterior y registra cada cambio que se le realice después de la instantánea de migración.
• Confirma tu rama y repositorio de producción en la página de ajustes de Git de tu panel.
• Anota tus registros DNS actuales y mantén tu sitio anterior en funcionamiento hasta que verifiques que tu despliegue de Mintlify está en producción.
• Revisa la barra de navegación, el pie de página, el favicon, el logotipo, los colores y la tipografía.
• Revisa los metadatos del sitio y de las páginas, las URL canónicas y las preferencias de indexación. Consulta SEO y ajustes de búsqueda.
• Instala las integraciones de analítica necesarias y, opcionalmente, añade una página 404 personalizada.
• Si migraste una referencia de API, compara las páginas de endpoints, la estructura de navegación, las URL de servidor, los esquemas de autenticación y los ejemplos con tu sitio anterior.
• Previsualiza tu commit exacto de lanzamiento en un despliegue de previsualización. Comprueba los diseños en escritorio y móvil, páginas de cada sección de navegación, la búsqueda y tus redirecciones.
• Revisa la consola del navegador y la pestaña de red por si hay errores en páginas que utilicen componentes o scripts personalizados.
• Cambia tu dominio siguiendo la guía de dominio personalizado, que cubre la migración sin tiempo de inactividad para un dominio que ya sirve documentación.
• Tras el lanzamiento, monitorea los errores 404, los fallos de redirección y los fallos de compilación.

• Exportar datos
• Estructura de la documentación
• Versionado
• Compatibilidad con OpenAPI
• Contenido reutilizable