16 lines
1.2 KiB
Markdown
16 lines
1.2 KiB
Markdown
# brush documentation
|
|
|
|
User-facing documentation lives at [brush.sh](https://brush.sh): [installation](https://brush.sh/getting-started/install/), the [compatibility](https://brush.sh/reference/compatibility/), [configuration](https://brush.sh/reference/config-files/), and [command-line](https://brush.sh/reference/usage/) references, and [release notes](https://brush.sh/releases/). The reference pages are generated from this directory at each release.
|
|
|
|
The docs here are for people working on brush itself:
|
|
|
|
* [How-to guides](how-to/README.md) for building, testing, benchmarking, and releasing
|
|
* [Reference material](reference/README.md) for compatibility, configuration, experimental features, and project policies
|
|
* [Explanation](explanation/README.md) of how brush is built, starting with its [architecture](explanation/architecture.md)
|
|
|
|
If you're just getting started with the codebase, start with the [How to build](how-to/build.md) guide and [CONTRIBUTING.md](../CONTRIBUTING.md).
|
|
|
|
---
|
|
|
|
> _Note: The structure of our docs is inspired by the [Diátaxis](https://diataxis.fr/) 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._
|