Instructions
When migrating documentation from another platform:
Step 1: Detect Source Format
Identify the documentation source by looking for:
| Platform | Detection Files |
|---|---|
| Mintlify | mint.json, .mintlify/ |
| Docusaurus | docusaurus.config.js, sidebars.js |
| GitBook | SUMMARY.md, .gitbook.yaml |
| ReadMe | readme-oas.json, .readme/ |
| VuePress | .vuepress/config.js |
| MkDocs | mkdocs.yml |
| Sphinx | conf.py, index.rst |
| README only | README.md (no other docs) |
Step 2: Migration Mappings
Mintlify → DevDoc
code
mint.json → docs.json ├── name → name ├── logo → (extract to assets/logo/) ├── favicon → favicon ├── colors → theme.json ├── navigation → navigation.tabs + groups ├── topbarLinks → navbar ├── anchors → navigation.global.anchors └── api → api Component Mappings: ├── <Accordion> → <Accordion> ├── <AccordionGroup> → <AccordionGroup> ├── <Card> → <Card> ├── <CardGroup> → <CardGroup> ├── <CodeGroup> → <Tabs> with code ├── <Tabs> → <Tabs> ├── <Tab> → <Tab> ├── <Info> → <Info> ├── <Note> → <Note> ├── <Tip> → <Tip> ├── <Warning> → <Warning> ├── <Check> → <Tip> (with check icon) ├── <Steps> → <Steps> ├── <Step> → <Step> ├── <Frame> → (image wrapper, convert to <img>) ├── <ResponseField> → (convert to table) └── <ParamField> → (convert to table)
Docusaurus → DevDoc
code
docusaurus.config.js → docs.json ├── title → name ├── favicon → favicon ├── themeConfig.navbar → navbar ├── themeConfig.footer → (extract links to anchors) └── docs.sidebarPath → navigation sidebars.js → navigation.tabs[].groups Component Mappings: ├── :::note → <Note> ├── :::tip → <Tip> ├── :::info → <Info> ├── :::caution → <Warning> ├── :::danger → <Warning> ├── <Tabs> → <Tabs> ├── <TabItem> → <Tab> └── import/export → (inline or convert to snippets)
GitBook → DevDoc
code
SUMMARY.md → docs.json navigation
├── # Group → groups[].group
├── * [Page](path.md) → groups[].pages[]
└── Nested items → nested groups
Component Mappings:
├── {% hint style="info" %} → <Info>
├── {% hint style="warning" %} → <Warning>
├── {% hint style="danger" %} → <Warning>
├── {% hint style="success" %} → <Tip>
├── {% tabs %} → <Tabs>
├── {% tab title="X" %} → <Tab title="X">
├── {% code title="X" %} → ```language title="X"
└── {% embed url="X" %} → <iframe> or link
Step 3: Execute Migration
- •Convert configuration files
- •Transform MDX/MD content with component mappings
- •Copy and organize assets
- •Generate docs.json navigation
- •Create theme.json from color settings
Step 4: Post-Migration Validation
After migration:
- •Run
/check-docsto verify all links work - •Preview with
devdoc dev - •Check component rendering
- •Verify navigation structure