4 Commits

Author SHA1 Message Date
Mike McQuaid
ac0665daff
Refer to default branch in links with HEAD
Anywhere we can use `blob/master` we can use `blob/HEAD` instead. This
will make life easier if we ever rename our default branch in future
(once/if Git and GitHub provides the necessary tooling to do so).
2020-06-25 11:38:40 +01:00
Issy Long
dac41ba275
Scope the Vale "terms" substitution lint to paragraphs only
- This clears up the final four title-case "Pull Request" in titles,
  which are correct.
2019-12-18 16:09:07 +00:00
Issy Long
a5ffdc6c5a
Use Title Case in h1 headings and sentence case in all others
- I wrote about the implications of (not) doing this in the PR
  (https://github.com/Homebrew/brew/pull/6826#issuecomment-564273209),
  but in summary:

  - It looks like pretty much the only place we've ever adhered to the
    sentence case rule is the Prose Guidelines itself.
  - Correcting all these to sentence case would be a lot of work (and
    sometimes not even make sense).
  - Admittedly, some of the title case ones look a bit horrible, but
    even with some allowed exceptions, but it's better than being
    consistently inconsistent.
  - Only lint for title case in h1 headings. H2s and H3s etc. can be
    sentence case. There's not currently a lint for that.
2019-12-18 16:09:07 +00:00
Issy Long
2a53448685
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).
2019-12-17 21:42:53 +00:00