Twenty Documentation

Official documentation for Twenty CRM, powered by Mintlify.

🌐 Live Site

Visit the documentation at docs.twenty.com

This repository contains:

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

Edit MDX files in the appropriate directory:
- user-guide/ - User documentation
- developers/ - Developer documentation
- twenty-ui/ - Component documentation
Update navigation/base-structure.json if you need to change the tab/group hierarchy or add/remove pages. This file stays in the repo and is not uploaded to Crowdin.
Keep the translation template (navigation/navigation.template.json) in sync by running yarn docs:generate-navigation-template after editing the base structure. This template is the only file that should be pushed to Crowdin.
For each translated locale pulled from Crowdin, ensure a packages/twenty-docs/l/<language>/navigation.json file exists. These files contain labels only; page slugs always come from the base structure.
Run yarn docs:generate to rebuild docs.json from the base structure + translated labels.

All documentation pages use MDX format with frontmatter:

mdx

---
title: Page Title
description: Page description
image: /images/path/to/image.png
---

Your content here...

mdx

<Frame>
  
</Frame>

navigation/base-structure.json - Source of truth for tabs, groups, icons, and page slugs (English only, not sent to Crowdin).
navigation/navigation.template.json - Generated translation template (labels only) that is uploaded to Crowdin.
l/<language>/navigation.json - Locale-specific label files pulled from Crowdin.
docs.json - Generated Mintlify configuration (always run yarn docs:generate after modifying navigation files).
package.json - Package dependencies and scripts (docs:generate, docs:generate-navigation-template, …).
project.json - Nx workspace configuration

bash

# Build the documentation
npx nx run twenty-docs:build

To contribute to the documentation:

This documentation is part of the Twenty project and is licensed under AGPL-3.0.