Mintlify Migration Summary

What Was Migrated

Documentation Files

69 MDX files copied from twenty-website to twenty-docs
45 User Guide articles
22 Developer documentation articles
2 Getting Started guides (existing)

Images & Assets

81 images copied to public/images/
User guide screenshots
Developer documentation images
Logo and branding assets

Complete mint.json configuration with tabs and nested navigation
User Guide tab with 11 sections
Developers tab with 6 sections

Components Converted

Custom Components → Mintlify Equivalents

<ArticleWarning> → <Warning>
<ArticleLink href="...">text</ArticleLink> → [text](...)
<ArticleEditContent> → Removed (not needed)

Still Need Manual Review

Some components may need additional conversion:

<ArticleTabs> - Mintlify uses <Tabs> component
Embedded iframes/videos - May need adjustment
Custom styled elements - Review for Mintlify compatibility

Directory Structure

packages/twenty-docs/
├── mint.json                       # Main configuration
├── user-guide/
│   ├── getting-started/           # 7 files
│   ├── data-model/                 # 6 files
│   ├── crm-essentials/             # 4 files
│   ├── views/                      # 2 files
│   ├── workflows/                  # 7 files
│   ├── collaboration/              # 3 files
│   ├── integrations-api/           # 3 files
│   ├── reporting/                  # 1 file
│   ├── settings/                   # 9 files
│   ├── pricing/                    # 1 file
│   └── resources/                  # 2 files
├── developers/
│   ├── self-hosting/               # 5 files
│   ├── api-and-webhooks/           # 2 files
│   ├── frontend-development/       # 8 files
│   ├── backend-development/        # 7 files
│   ├── local-setup.mdx
│   └── bug-and-requests.mdx
└── public/
    └── images/                     # 81 images

Testing

Start the local Mintlify dev server:

npx nx run twenty-docs:dev

Open http://localhost:3000 to preview all migrated documentation.

Deployment

To deploy to Mintlify:

Push changes to GitHub
Connect the repo in Mintlify dashboard
Set subdirectory to packages/twenty-docs
Mintlify will auto-deploy and generate search embeddings

Status

This migration has been completed. The legacy packages/twenty-website package has been removed, and documentation now lives in packages/twenty-docs.

Known Issues to Review

ArticleTabs components may need manual conversion
Some images may have incorrect paths
Custom styled components may need adjustment
Video embeds might need review

2.8 KiB Raw Permalink Blame History