diff --git a/README.md b/README.md index e7493d5..159b396 100644 --- a/README.md +++ b/README.md @@ -7,3 +7,11 @@ This is the repo for the Positron documentation site. This site is built with [Q ## Reporting issues We currently use the issue tracker for [Positron](https://github.com/posit-dev/positron). Please report documentation bugs and feature requests at . + +## Linting + +This project uses [Vale](https://vale.sh/docs/) for automated linting and compliance with the Posit style guide. Vale runs [via GH action on PRs](https://github.com/posit-dev/positron-docs/actions/workflows/lint.yml), but you can also run it locally before you submit a PR. + +- [Install Vale](https://vale.sh/docs/vale-cli/installation/) locally. +- Use `quarto render` to generate the HTML that can be linted. +- Use `vale _site/` to lint the HTML generated by Quarto.