Skip to content

Commit

Permalink
Add instructions to README
Browse files Browse the repository at this point in the history
  • Loading branch information
juliasilge committed Oct 10, 2024
1 parent e2d1486 commit 96c725d
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://github.com/posit-dev/positron/issues>.

## 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.

0 comments on commit 96c725d

Please sign in to comment.