Abdul RahmanandGitHub
9f97be67b1
## Summary Completes the migration of all documentation from twenty-website to a new Mintlify-powered documentation site at docs.twenty.com. ## Changes Made ### New Package: `twenty-docs` - ✅ Created new Mintlify documentation package - ✅ Migrated 95 content pages (user-guide, developers, twenty-ui) - ✅ Migrated 81 images - ✅ Converted all custom components to Mintlify native components - ✅ Configured navigation with 2 tabs and 94 pages - ✅ Added Helper AI Agent with searchArticles tool for docs search ### Updated: `twenty-website` - ✅ Added 11 redirect rules (301 permanent) in next.config.js - ✅ Removed all documentation content (111 files) - ✅ Removed documentation routes (user-guide, developers, twenty-ui) - ✅ Removed documentation components (9 files) - ✅ Updated keystatic.config.ts - ✅ Preserved all marketing/release pages ### Updated: Core Files - ✅ Updated README.md - docs links point to docs.twenty.com - ✅ Updated CONTRIBUTING.md - code quality link updated - ✅ Updated SupportDropdown.tsx - user guide link updated - ✅ Updated Footer.tsx - user guide link updated
95 lines
2.1 KiB
Markdown
95 lines
2.1 KiB
Markdown
# Twenty Documentation
|
|
|
|
Official documentation for Twenty CRM, powered by [Mintlify](https://mintlify.com).
|
|
|
|
## 🌐 Live Site
|
|
|
|
Visit the documentation at [docs.twenty.com](https://docs.twenty.com)
|
|
|
|
## 📚 Content
|
|
|
|
This repository contains:
|
|
- **User Guide** (46 pages) - Complete guide for Twenty users
|
|
- **Developers** (24 pages) - Technical documentation for developers
|
|
- **Twenty UI** (25 pages) - UI component library documentation
|
|
|
|
## 🚀 Local Development
|
|
|
|
To run the documentation locally:
|
|
|
|
```bash
|
|
# From the twenty monorepo root
|
|
npx nx run twenty-docs:dev
|
|
```
|
|
|
|
The documentation will be available at `http://localhost:3000`
|
|
|
|
## 📝 Editing Content
|
|
|
|
### Adding/Editing Pages
|
|
|
|
1. Edit MDX files in the appropriate directory:
|
|
- `user-guide/` - User documentation
|
|
- `developers/` - Developer documentation
|
|
- `twenty-ui/` - Component documentation
|
|
|
|
2. Update `docs.json` to add pages to navigation
|
|
|
|
### MDX Format
|
|
|
|
All documentation pages use MDX format with frontmatter:
|
|
|
|
```mdx
|
|
---
|
|
title: Page Title
|
|
description: Page description
|
|
image: /images/path/to/image.png
|
|
---
|
|
|
|
Your content here...
|
|
```
|
|
|
|
### Adding Images
|
|
|
|
1. Place images in the `/images/` directory
|
|
2. Reference them in MDX: ``
|
|
3. Or use Mintlify Frame component:
|
|
```mdx
|
|
<Frame>
|
|
<img src="/images/your-image.png" alt="Description" />
|
|
</Frame>
|
|
```
|
|
|
|
## 🔧 Configuration
|
|
|
|
- `docs.json` - Main Mintlify configuration (navigation, theme, etc.)
|
|
- `package.json` - Package dependencies and scripts
|
|
- `project.json` - Nx workspace configuration
|
|
|
|
## 📦 Building
|
|
|
|
```bash
|
|
# Build the documentation
|
|
npx nx run twenty-docs:build
|
|
```
|
|
|
|
## 🔗 Links
|
|
|
|
- [Twenty Website](https://twenty.com)
|
|
- [GitHub Repository](https://github.com/twentyhq/twenty)
|
|
- [Mintlify Documentation](https://mintlify.com/docs)
|
|
|
|
## 🤝 Contributing
|
|
|
|
To contribute to the documentation:
|
|
|
|
1. Fork the repository
|
|
2. Make your changes in the `packages/twenty-docs` directory
|
|
3. Test locally with `npx nx run twenty-docs:dev`
|
|
4. Submit a pull request
|
|
|
|
## 📄 License
|
|
|
|
This documentation is part of the Twenty project and is licensed under [AGPL-3.0](../../LICENSE).
|
|
|