mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
Ethan Palm
017d7c7377
* fix: reduce Vale false positives via vocab and config updates - Make English-word vocab entries case-insensitive so sentence-start capitalization and normal prose usage stop flagging (agents, rest, cursor, setup, endpoints, etc.) - Add vocab entries for filenames and code identifiers that appear in frontmatter and JSX contexts (docs.json, llms.txt, CLAUDE.md, etc.) - Ignore openapi frontmatter lines, filenames, JSX attributes, email addresses, and internal link targets via TokenIgnores - Skip inline code scope and indented code fences - Add Headings exceptions for proper nouns (Claude Code, GitHub Actions, Route 53, GA4, etc.) - Disable linting for the all-code vercel-json-generator snippet Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * fix: resolve all Vale warnings and errors across docs Content fixes: - Reword sentences using 'will', first person, spaced em dashes, 'e.g.', Latin abbreviations, and hyphenated adverbs - Sentence-case headings that started with dotted filenames - Backtick literal API values instead of bolding them - Move periods inside quotation marks - Fix Oxford comma rule misfires by restructuring sentences False-positive suppression: - Vale toggles around example user questions, keyboard shortcut keys (Cmd+I), UI labels, and code samples in JSX contexts that Vale misparses - Exclude vale toggle comments from the brace Token/BlockIgnores so in-document commands actually reach Vale (the greedy brace pattern was also silently swallowing large regions; now lazy) - Vocab entries for code identifiers (internal_id, handleSubmit, etc.) - Per-file rule disables for component docs with dotted JSX names and files where link-target linting ignores in-document toggles Result: vale --minAlertLevel warning is clean repo-wide; only suggestion-level items (Passive, Semicolons, Acronyms) remain. mint broken-links passes. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * fix: correct WordList rule instead of degrading prose - Restore sentence-start "Email" in advanced-support; the rule now only flags hyphenated e-mail/E-mail forms - Restore the idiom "above all else"; the above->preceding swap now exempts "above all" Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * fix: restore deliberate prose flagged by blunt rules - Restore spatial 'above the navbar' / 'above a page title' in custom-scripts; the above->preceding swap now exempts 'above the/a/an' - Restore the '= ...' in the react-components named-export example (the ellipsis is inside inline code) with an Ellipses toggle - Restore SLA phrasing 'will use commercially reasonable efforts' with a Will toggle - Restore the quoted developer question in the GEO guide intro with a FirstPerson toggle, matching the file's other example questions Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * fix: remove WordList swaps that flag legitimate English - Drop tablet->device and firewalls->firewall rules; both words are correct in ordinary prose - Narrow touch->tap to UI-instruction phrasing (touch the/a) so 'keep in touch' and 'touch devices' stop flagging Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * fix: reposition vale toggles to wrap whole blocks Toggle comments placed between list items split the lists (restarting ol numbering in deployments) and comments flush against tables risked breaking GFM table parsing. Wrap entire lists/tables with blank-line separation instead. Verified rendering with mint dev: single ol with two items, tables intact, no comments in visible DOM. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * refactor: prune accept.txt to load-bearing entries Empirically removed 166 vocab entries (575 -> 409) whose removal causes no Vale flags across all 908 English pages: dictionary words that never needed listing (agents, setup, endpoints, webhooks, yaml), lowercase entries the speller already accepts, and filename entries made redundant by inline vale toggles. Kept every case-enforcing entry (API, JSON, GitHub, ...) so casing policy is unchanged, plus entries that double as capitalization exceptions for headings (mcp, md, auth, cursor, txt). Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * Update ai/mintlify-mcp.mdx * Update api/agent/v2/create-agent-job.mdx * chore: alphabetize Headings exceptions and accept.txt Case-insensitive sort, ignoring the (?i) prefix; also drops a duplicate Scala entry. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * fix: re-apply OxfordComma rewrite lost in branch merge Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * docs: resolve Vale suggestions batch 1 (acronyms, semicolons, passive voice) Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * docs: resolve remaining Vale suggestions (passive voice batch 2) Rewrite ~90 passive constructions to active voice across deploy, guides, migration-services, and organize docs. Toggle the deliberate passive examples in the style-and-tone guide ('by zombies' test). Add axios/lodash vocab entries for a repositioned code example. vale . is now fully clean: 0 errors, 0 warnings, 0 suggestions. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> --------- Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
124 lines
5.5 KiB
Plaintext
124 lines
5.5 KiB
Plaintext
---
|
|
title: "Migration services"
|
|
description: "Learn about the Enterprise plan migration process from your existing documentation platform, including delivery timelines and quality assurance steps."
|
|
---
|
|
|
|
Your Enterprise plan includes migration services to transfer your documentation to Mintlify. This guide covers the migration process, delivery timelines, and our quality assurance approach.
|
|
|
|
## 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, branding (logos, colors, and fonts), API reference pages, and navigation structure.
|
|
|
|
Your migration includes a staging link to review progress and a 3-day feedback window after delivery to address any issues with content, assets, or branding.
|
|
|
|
<Info>
|
|
Migration services **do not** include:
|
|
- Dynamic syncing of your documentation
|
|
- Design or information architecture consultation
|
|
- Custom component development (landing pages, custom integrations, etc.)
|
|
- Redirects setup
|
|
- Analytics setup
|
|
</Info>
|
|
|
|
## Migration process
|
|
|
|
<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="Receive scoping and timeline (1-2 business days)">
|
|
We review your submission and provide an estimated delivery timeline within 24-48 hours. We'll flag any custom components or areas of your migration that need discussion.
|
|
</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.
|
|
</Step>
|
|
|
|
<Step title="Receive final delivery">
|
|
We deliver your migration via GitHub PR or zip file based on your preference.
|
|
</Step>
|
|
|
|
<Step title="Feedback window (three business days)">
|
|
Submit any feedback on content, assets, or branding. We address all in-scope issues within the same timeframe.
|
|
</Step>
|
|
|
|
<Step title="Go-live support">
|
|
We provide documentation and guidance for connecting your repository, setting up redirects, and configuring your custom domain.
|
|
</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:
|
|
|
|
<Card title="Content completeness" icon="file-check">
|
|
- All documentation from your source appears in your new docs.
|
|
- 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 apply throughout.
|
|
- Light and dark mode logos display appropriately.
|
|
- Color schemes meet contrast requirements in both modes.
|
|
</Card>
|
|
|
|
<Card title="Functionality" icon="rocket">
|
|
- All links work correctly (no broken links).
|
|
- 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:
|
|
|
|
1. [Connect your GitHub repository and get setup](https://www.mintlify.com/docs/quickstart#install-the-github-app).
|
|
2. [Set up redirects if required](https://www.mintlify.com/docs/create/redirects).
|
|
3. [Configure your custom domain](https://www.mintlify.com/docs/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.
|
|
- 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.
|
|
|
|
<Note>
|
|
**Need help?** Our support team is available to guide you through these steps. Reach out via [support@mintlify.com](mailto:support@mintlify.com).
|
|
</Note>
|
|
|
|
## Frequently asked questions
|
|
|
|
<AccordionGroup>
|
|
<Accordion title="How long does a migration take?">
|
|
We typically deliver migrations within 10 business days, depending on complexity. You'll receive a specific timeline within 24-48 hours of submitting your migration form.
|
|
</Accordion>
|
|
|
|
<Accordion title="Can I request changes after delivery?">
|
|
Yes. You have a 3-day feedback window after delivery to request changes to content, assets, or branding. We address all in-scope feedback within the same 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.
|
|
</Accordion>
|
|
|
|
<Accordion title="Can I customize the navigation structure?">
|
|
Yes. You can provide a custom information architecture in the migration form, and we'll implement it. However, custom component development (like custom landing pages) is not included in the migration service.
|
|
</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 carry over. Complete all updates before starting the migration.
|
|
</Accordion>
|
|
</AccordionGroup>
|