User-facing documentation lives at brush.sh: installation, the compatibility, configuration, and command-line references, and release notes. The reference pages are generated from this directory at each release.
The docs here are for people working on brush itself:
- How-to guides for building, testing, benchmarking, and releasing
- Reference material for compatibility, configuration, experimental features, and project policies
If you're just getting started with the codebase, start with the How to build guide and CONTRIBUTING.md.
Note: The structure of our docs is inspired by the Diátaxis approach; we've found over time that best helps readers find the material most relevant to them, as well as provides a rough shape for where to place the right docs.