Include (Vale) grammar linter with the Easy Button #14
Description
In the spirit of the Good Docs Project, I'd like to propose the use of Vale as part of the "Easy Button". With Vale, writers with appropriate software (such as IDEs) can automate grammar checks of what they write. As Vale does not share content with other sources (like some other grammar checkers), security engineers are less likely to object.
When integrated with an IDE, it's as "easy" to use as linters for programming languages or Markdown. Several companies have implemented style guides with Vale. Two of the most popular are:
- Google, https://github.com/errata-ai/Google
- Microsoft, https://github.com/errata-ai/Microsoft
At least Google (and quite possibly Microsoft) companies update their style guides frequently. It'd be useful to "pull" these changes into the noted repositories, as a "source" that others could use, and pull into their implementations of Vale.
Unfortunately, the noted repositories haven't been updated for nearly a year. As I've taken my use of the Google Developer Style guide from the noted repo, my implementation is out of date.
During the 2022 Write the Docs conference, there was discussion about a script that would pull updates -- ideally from a style guide repo that is also up to date.
After a discussion with @camerons, we realized that the style guide repo needs updates. As shown in their "What's New" log, the Google Developer Style Guide ( https://developers.google.com/style/whats-new) is updated weekly.
Cameron, who works for Google (and also helps with the Good Docs Project) noted that the public "What's New" log is relatively light on details relative to the actual change.
IMO, in an "ideal world", Google would take charge of updating the repo, and we'd all have the unknown script that would keep the Vale rules that we import up to date.
An alternative: if we're able to get more detail about Google changes to the developer style guide (I thank Cameron for his willingness to ask), can we, as open source contributors, help keep such a repo up to date?
Apparently, several groups have been working on Vale, and I don't think there's anyone whose been putting it together. Someone shared this Rule explorer, https://share.streamlit.io/jdkato/rules/main/app/main.py. Perhaps users from these companies are willing to help.