docs
docs copied to clipboard
railwayapp
Zuchka/add vale action
This PR adds a very lightweight version of the Vale Github Action to the docs repo. A few things to note:
- this is just an initial setup. It will only run about four tests. Three tests come from the built-in
Valepackage and those check for pretty uncontroversial things: spelling errors, repeated words, stuff like that. The other one is a readability test that will output a readability score for the each page. I see this as a small foundation for building out our own house style - I've also started a 'Vocab' section. It's like an allow-list of words the spell-checker won't flag. This is also the beginning of our customizations and it's totally open to revisions
- the GH action is informative only and totally non-blocking. It doesn't stop anything from getting merged--it only provides helpful feedback.
- I included a small section in the readme on how you can set up the repo and Vale to run your own tests locally.
I'm excited to start building this out!
This PR was not deployed automatically as @zuchka does not have access to the Railway project.
In order to get automatic PR deploys, please add @zuchka to your team on Railway.
![railway-app[bot] avatar](https://avatars.githubusercontent.com/in/73253?v=4 "Published by a pub.dev verified publisher"){kind=small}
SO COOOOL. Agree on maybe waiting to merge until mine goes.. or maybe only merge the base of the Vale set up and not the fixes? or maybe it doesn't matter since I haven't made all of the big organization changes yet and could probably merge main into mine with minor conflict. I'm fine either way and excited to get this in
SO COOOOL. Agree on maybe waiting to merge until mine goes.. or maybe only merge the base of the Vale set up and not the fixes? or maybe it doesn't matter since I haven't made all of the big organization changes yet and could probably merge main into mine with minor conflict. I'm fine either way and excited to get this in
@melissa-hale agree! I will merge the GH action itself but not any of the edits. Once your overhaul is in we can re-assess :)