Add Vale linting for our docs
- I noticed that another open source project had taken the Homebrew style guide and made it into [Vale linting rules](https://github.com/testthedocs/vale-styles/tree/master/Homebrew). This copies them into here, so that we can make use of them. Thanks! - What use is a style guide if our own docs don't at least try to adhere to it? This aims to make the rules more visible to all contributors. - In order for these to do anything, you'll have to `brew install vale` and run `vale` in the root of this repo. It will look for Markdown files. - A next step would be adding this as a pre-commit hook, or... - The GitHub Action would have been really good, but [it doesn't support forks](https://github.com/errata-ai/vale-action#limitations).
Showing
- docs/_config.yml 1 addition, 0 deletionsdocs/_config.yml
- docs/vale-styles/Homebrew/Abbreviations.yml 12 additions, 0 deletionsdocs/vale-styles/Homebrew/Abbreviations.yml
- docs/vale-styles/Homebrew/OxfordComma.yml 8 additions, 0 deletionsdocs/vale-styles/Homebrew/OxfordComma.yml
- docs/vale-styles/Homebrew/Pronouns.yml 15 additions, 0 deletionsdocs/vale-styles/Homebrew/Pronouns.yml
- docs/vale-styles/Homebrew/README.md 1 addition, 0 deletionsdocs/vale-styles/Homebrew/README.md
- docs/vale-styles/Homebrew/Spacing.yml 9 additions, 0 deletionsdocs/vale-styles/Homebrew/Spacing.yml
- docs/vale-styles/Homebrew/Terms.yml 9 additions, 0 deletionsdocs/vale-styles/Homebrew/Terms.yml
- docs/vale-styles/Homebrew/Titles.yml 6 additions, 0 deletionsdocs/vale-styles/Homebrew/Titles.yml
- docs/vale-styles/Homebrew/Trademarks.yml 12 additions, 0 deletionsdocs/vale-styles/Homebrew/Trademarks.yml
docs/vale-styles/Homebrew/Abbreviations.yml
0 → 100644
docs/vale-styles/Homebrew/OxfordComma.yml
0 → 100644
docs/vale-styles/Homebrew/Pronouns.yml
0 → 100644
docs/vale-styles/Homebrew/README.md
0 → 100644
docs/vale-styles/Homebrew/Spacing.yml
0 → 100644
docs/vale-styles/Homebrew/Terms.yml
0 → 100644
docs/vale-styles/Homebrew/Titles.yml
0 → 100644
docs/vale-styles/Homebrew/Trademarks.yml
0 → 100644
Please register or sign in to comment