Docs
Source: github.com/tuist/tuist/tree/main/docs
What it is for
The docs site hosts Tuist’s product and contributor documentation. It is built with VitePress.
How to contribute
Set up locally
bash
cd docs
mise install
mise run devOptional generated data
We embed some generated data in the docs:
- CLI reference data:
mise run generate-cli-docs
These are optional. The docs render without them, so only run them when you need to refresh the generated content.
The ProjectDescription API reference is hosted separately as a DocC site at projectdescription.tuist.dev. To build it locally, run mise run docs:project-description from the repository root.