Add migration guides - #6996
Open
ethanpalm wants to merge 16 commits into
Open
Conversation
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
…examples - migration/gitbook.mdx: GitBook renamed spaces to sections. Their current docs use "section" exclusively across the Git Sync, content-structure, content-configuration, and reusable-content pages. Update terminology throughout, add a note about the older name, correct the Git Sync setup steps to match the real flow (Set up next to Git Sync in the section header, then pick a provider), and expand the direction warning with the version-history rollback. Add a Vale.Terms toggle so .gitbook.yaml and .gitbook/ paths do not trip the GitBook capitalization rule. - migration/document360.mdx: fix "Document 360" typo and align the export procedure with Document360's documented dialog order, including the format selection, the Include media files checkbox, and downloading from Recent files. - Revert components/banner.mdx and its es/fr/zh copies. The /migration link there is a placeholder inside an example, and translated content is handled by the translation pipeline. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
The group is already called "Migrate to Mintlify", so the root page title repeated it in the sidebar. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
…holders - migration/fern.mdx: correct the source-content paths against Fern's documented project structure. Pages live in fern/docs/pages/ and assets in fern/docs/assets/. Add the previously missing fern/docs/snippets/, fern/docs/changelog/, and fern/styles.css, note that only the fern and changelog folder names are reserved, and map Fern snippets to Mintlify snippets in the component table. - migration/index.mdx: document the scraper's page command, which was only documented in the deleted migration.mdx. Covered once here rather than repeated in each scraper-supported platform guide. Also update the GitBook card to say section instead of space. - migration/readme.mdx: replace https://project.readme.io with https://your-project.readme.io. The former is a real login-gated project. - migration/docusaurus.mdx: remove trailing whitespace. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documentation changes
Creates a migration group with individual guides for frequently migrated from platforms.
Closes https://linear.app/mintlify/issue/DOC-409/migration-guides-for-each-major-competitor-platform
For Reviewers
When reviewing documentation PRs, please consider:
✅ Technical accuracy
✅ Clarity and completeness
✅ User experience
Note
Low Risk
Documentation-only restructure with new MDX pages and redirect updates; no application or security logic changes.
Overview
Replaces the single Migrate to Mintlify page with a migration section in
docs.json(overview plus seven guides) and removes the oldmigration.mdxhub.New guides cover Docusaurus, ReadMe, GitBook, Fern, Document360, a generic manual path, and a shared go-live checklist. Each platform page documents when to scrape vs export from source, how to map navigation to
docs.json, component/syntax conversion tables, API spec handling, assets, URLs/redirects, and review steps—often linking to/migration/go-live.The overview (
migration/index) routes readers via cards to each guide and documents scraperpage/sectionusage and GitHub→mintlify.com site generation.Redirects in
redirects.jsonpoint/guides/migrationand/migrationto/migration/index.Reviewed by Cursor Bugbot for commit 0289729. Bugbot is set up for automated code reviews on this repo. Configure here.