Migrer depuis 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/             Guides organisés par catégorie
reference/        Pages de référence API et fichiers OpenAPI
recipes/          Recettes étape par étape
custom_pages/     Pages personnalisées Markdown ou HTML
custom_blocks/    Blocs personnalisés réutilisables
_order.yaml       Ordre au sein d'un dossier ou d'une catégorie

• Callouts, onglets, accordéons, cartes et groupes de code
• Contenu réutilisable et blocs personnalisés
• Variables et termes du glossaire
• Recettes interactives
• Pages HTML personnalisées
• Explorateurs d’API intégrés et contenu personnalisé

1. Trouvez chaque fichier OpenAPI JSON ou YAML dans reference/ et dans tout référentiel source que vous avez utilisé avec rdme ou la synchronisation d’API de ReadMe.
2. Identifiez le Markdown que les éditeurs ont ajouté dans ReadMe en dehors de la spécification. ReadMe associe ce contenu à une opération par son operationId.
3. Ajoutez la spécification à votre référentiel Mintlify et configurez des pages générées par OpenAPI.
4. Déplacez le Markdown supplémentaire pertinent dans la description de l’opération concernée, la description du schéma ou un guide adjacent.
5. Comparez l’authentification, les URL de serveur, les exemples de code, les exemples et l’ordre des endpoints avec votre référence originale.

• Une version par défaut différente et un comportement d’URL différent
• Versions cachées, bêta et dépréciées
• Contenu réutilisable spécifique à une version
• Pages qui existent dans une seule version
• Spécifications API qui diffèrent selon la version
• Pages personnalisées partagées ou contenu de changelog

• Les URL de la version par défaut qui omettent le segment de version
• Les pages personnalisées sous /page
• Les guides et pages de référence qui partagent le même slug
• Les chemins d’endpoints dérivés des tags et résumés OpenAPI
• Les pages dépréciées ou cachées qui reçoivent encore du trafic

​

Lancez votre nouveau site

• Instaurez un gel de contenu sur votre ancien site et suivez chaque modification qui y est apportée après votre instantané de migration.
• Confirmez votre branche de production et votre référentiel sur la page Paramètres Git de votre tableau de bord.
• Notez vos enregistrements DNS existants et gardez votre ancien site en ligne jusqu’à ce que vous ayez vérifié que votre déploiement Mintlify est actif.
• Vérifiez la barre de navigation, le pied de page, le favicon, le logo, les couleurs et la typographie.
• Vérifiez les métadonnées du site et des pages, les URL canoniques et les préférences d’indexation. Voir Paramètres SEO et de recherche.
• Installez toutes les intégrations d’analytique requises, et ajoutez éventuellement une page 404 personnalisée.
• Si vous avez migré une référence API, comparez les pages d’endpoints, la structure de navigation, les URL de serveur, les schémas d’authentification et les exemples avec votre ancien site.
• Prévisualisez votre commit de lancement exact dans un déploiement de prévisualisation. Vérifiez les mises en page desktop et mobile, les pages de chaque section de navigation, la recherche et vos redirections.
• Vérifiez la console du navigateur et l’onglet réseau pour détecter d’éventuelles erreurs sur les pages qui utilisent des composants ou des scripts personnalisés.
• Basculez votre domaine avec le guide sur les domaines personnalisés, qui couvre la bascule sans interruption pour un domaine qui sert déjà de la documentation.
• Après le lancement, surveillez les erreurs 404, les échecs de redirection et les échecs de build.

• Exporter les données
• Structure de la documentation
• Gestion des versions
• Prise en charge d’OpenAPI
• Contenu réutilisable