@ -10,6 +10,14 @@ If you are interested in contributing to the site and making changes, please ref
## Generated documentation
## Generated documentation
## Style checks
This repository uses [vale](https://github.com/errata-ai/vale) to run style checks. Make sure to install the tool and run the following command before creating a PR in order to check for styling issues:
```bash
yarn vale:check
```
### Blockstack CLI reference
### Blockstack CLI reference
The `src/_data/cli-reference.json` file is generated from the `stx` subcommand `docs`.
The `src/_data/cli-reference.json` file is generated from the `stx` subcommand `docs`.
@ -177,6 +177,14 @@ fetch external data at runtime and use it in some way within our pages.
## Tips and tricks
## Tips and tricks
### Style checks
We use the [Google Developer documentation style guides](https://developers.google.com/style/) in this project. Make sure to install [vale](https://github.com/errata-ai/vale) and run the style checks before you create a PR:
```bash
yarn vale:check
```
### Always use Markdown when possible
### Always use Markdown when possible
It's possible to write standard HTML when writing in Markdown, but that should be avoided at all costs. We use `remark` to
It's possible to write standard HTML when writing in Markdown, but that should be avoided at all costs. We use `remark` to