e7da97194a
Some checks failed
App Prod-Parity E2E Dispatch / dispatch (push) Failing after 10s
CD Storybook UI / build (push) Failing after 3m25s
CD Storybook UI / dispatch (push) Has been skipped
CD deploy main / website-changed-files (push) Successful in 18m8s
CI Agent Skills / changed-files-check (push) Successful in 18m9s
CI Create App E2E minimal / changed-files-check (push) Successful in 24s
CI Create App / changed-files-check (push) Successful in 26s
CI Docs / changed-files-check (push) Successful in 26s
CI Emails / changed-files-check (push) Successful in 28s
CI Example App Hello World / changed-files-check (push) Successful in 23s
CI Front / changed-files-check (push) Has been skipped
CI Example App Postcard / changed-files-check (push) Successful in 27s
CI UI / changed-files-check (push) Has been skipped
CI Utils Test / changed-files-check (push) Successful in 45s
CI Twenty Apps / discover (push) Successful in 1m3s
CD deploy main / deploy-main (push) Failing after 3s
CI Agent Skills / agent-skills-validate (push) Has been skipped
CI Create App / create-app-test (lint) (push) Has been skipped
CI Emails / emails-test (push) Has been skipped
CI Front / front-task (lingui:compile) (push) Has been skipped
CI Front / front-task (lint) (push) Has been skipped
CI Example App Postcard / example-app-postcard (push) Has been skipped
CI UI / ui-task (lint) (push) Has been skipped
CI UI / ui-task (pack-size) (push) Has been skipped
CI UI / ui-task (size) (push) Has been skipped
CI UI / ui-task (test) (push) Has been skipped
CI UI / ui-task (typecheck) (push) Has been skipped
CI Utils Test / utils-test (push) Has been skipped
CI Twenty Apps / ${{ matrix.app.name }} (push) Has been skipped
CI Emails / ci-emails-status-check (push) Successful in 2s
CI Example App Hello World / ci-example-app-hello-world-status-check (push) Successful in 2s
CI Example App Postcard / ci-example-app-postcard-status-check (push) Successful in 3s
CI UI / ui-sb-test (push) Has been skipped
CI Utils Test / ci-utils-test-status-check (push) Successful in 2s
CI Twenty Apps / ci-twenty-apps-status-check (push) Successful in 2s
CI UI / ci-ui-status-check (push) Successful in 2s
CI Desktop / desktop (push) Failing after 1m8s
Push docs to Crowdin / Push documentation to Crowdin (push) Failing after 55s
Push translations to Crowdin / Extract and upload translations (push) Failing after 5s
Push website translations to Crowdin / Extract and upload website translations (push) Failing after 5s
CI Create App / create-app-test (test) (push) Has been skipped
CI Create App / create-app-test (typecheck) (push) Has been skipped
CI Docs / docs-lint (push) Has been skipped
CI Example App Hello World / example-app-hello-world (push) Has been skipped
CI Front / front-task (lingui:extract) (push) Has been skipped
CI Front / front-task (test) (push) Has been skipped
CI Front / front-task (typecheck) (push) Has been skipped
CI UI / ui-sb-build (push) Failing after 1m32s
CI Twenty Apps / ${{ matrix.app.name }} (${{ matrix.server-source }}) (push) Has been skipped
CI Agent Skills / agent-skills-publish (push) Has been skipped
CI Create App / ci-create-app-status-check (push) Successful in 2s
CI Agent Skills / agent-skills-remote-source (push) Has been skipped
CI Create App E2E minimal / create-app-e2e-minimal (push) Has been cancelled
CI E2E Main / e2e-test (push) Has been cancelled
CI Front / front-sb-build (push) Has been cancelled
CI Front / front-build (push) Has been cancelled
CI Create App E2E minimal / ci-create-app-e2e-minimal-status-check (push) Has been cancelled
CI E2E Main / ci-e2e-main-status-check (push) Has been cancelled
CI E2E Main / notify-main-ci-failure (push) Has been cancelled
CI E2E Main / qa-scout-comment (push) Has been cancelled
CI Front / front-sb-test (push) Has been cancelled
CI Front / front-sb-screenshots (push) Has been cancelled
CI Front / ci-front-status-check (push) Has been cancelled
DPA Sub-Processor Sync / sync-subprocessors (push) Failing after 3s
AI Catalog Sync / sync-catalog (push) Failing after 2s
91 lines
2.8 KiB
Markdown
91 lines
2.8 KiB
Markdown
# 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
|
|
|
|
### Navigation Structure
|
|
- 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:
|
|
```bash
|
|
npx nx run twenty-docs:dev
|
|
```
|
|
|
|
Open http://localhost:3000 to preview all migrated documentation.
|
|
|
|
## Deployment
|
|
|
|
To deploy to Mintlify:
|
|
1. Push changes to GitHub
|
|
2. Connect the repo in Mintlify dashboard
|
|
3. Set subdirectory to `packages/twenty-docs`
|
|
4. 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
|