mirror of https://github.com/twentyhq/twenty.git synced 2026-06-12 01:46:39 -04:00

Files

Ariqhermawan 218799636f fix(docs): replace removed Mintlify build command (#20578 )

## Summary
Closes #20565.

The Twenty docs package still pointed contributors at the removed
`mintlify build` command. This switches the docs workflow to a
`validate` command, which matches the supported Mintlify CLI command for
validating the documentation build, and updates the README wording to
match.

## Changes
- Replaced the `twenty-docs` package `build` script with a `validate`
script.
- Renamed the Nx docs target from `build` to `validate` and kept it
wired to `mintlify validate`.
- Updated the README validation command to `npx nx run
twenty-docs:validate`.

## Verification
```bash
$ npx -y mintlify validate --help
usage: mintlify validate [options]

Options:
  -t, --telemetry        Enable or disable anonymous usage telemetry   [boolean]
      --groups           Mock user groups for validation                 [array]
      --disable-openapi  Disable OpenAPI file generation
                                                      [boolean] [default: false]
  -h, --help             Show help                                     [boolean]
  -v, --version          Show version number                           [boolean]

Examples:
  mintlify validate  validate the build
```

```bash
$ npx -y mintlify build
Unknown command: build
```

I also started `npx -y mintlify validate --disable-openapi`; the CLI
recognized the command and began validating, but this Windows
environment could not finish Mintlify framework extraction because it
hit an EPERM symlink error inside the local `.mintlify` cache.

2026-05-15 09:40:11 +00:00

3.2 KiB

Raw Permalink Blame History

Twenty Documentation

Official documentation for Twenty CRM, powered by Mintlify.

🌐 Live Site

Visit the documentation at 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:

# 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

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.

MDX Format

All documentation pages use MDX format with frontmatter:

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

Your content here...

Adding Images

Place images in the /images/ directory
Reference them in MDX: ![Alt text](/images/your-image.png)
Or use Mintlify Frame component:

<Frame>
  <img src="/images/your-image.png" alt="Description" />
</Frame>

🔧 Configuration

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

📦 Validation

# Validate the documentation build
npx nx run twenty-docs:validate

🔗 Links

🤝 Contributing

To contribute to the documentation:

Fork the repository
Make your changes in the packages/twenty-docs directory
Test locally with npx nx run twenty-docs:dev
Submit a pull request

📄 License

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

3.2 KiB Raw Permalink Blame History