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.
This commit is contained in:
Ariqhermawan
2026-05-15 16:40:11 +07:00
committed by GitHub
parent 14acd77626
commit 218799636f
3 changed files with 6 additions and 8 deletions
+3 -4
View File
@@ -72,11 +72,11 @@ Your content here...
- `package.json` - Package dependencies and scripts (`docs:generate`, `docs:generate-navigation-template`, …).
- `project.json` - Nx workspace configuration
## 📦 Building
## 📦 Validation
```bash
# Build the documentation
npx nx run twenty-docs:build
# Validate the documentation build
npx nx run twenty-docs:validate
```
## 🔗 Links
@@ -97,4 +97,3 @@ To contribute to the documentation:
## 📄 License
This documentation is part of the Twenty project and is licensed under [AGPL-3.0](../../LICENSE).
+1 -1
View File
@@ -6,7 +6,7 @@
"license": "AGPL-3.0",
"scripts": {
"dev": "mintlify dev",
"build": "mintlify build",
"validate": "mintlify validate",
"fix-links": "bash scripts/fix-translated-links.sh",
"lint": "npx oxlint -c .oxlintrc.json ."
},
+2 -3
View File
@@ -12,12 +12,11 @@
"command": "mintlify dev"
}
},
"build": {
"validate": {
"executor": "nx:run-commands",
"outputs": ["{projectRoot}/.mintlify"],
"options": {
"cwd": "{projectRoot}",
"command": "mintlify build"
"command": "mintlify validate"
}
},
"lint": {},