search

canonical / praecepta

Creative Commons Attribution Share Alike 4.0 International
12 stars 20 forks source link

Update Readme with manual check instructions #68

Closed izmalk closed 3 months ago

izmalk commented 4 months ago

Add instructions on how to check documentation with Vale manually.

ru-fu commented 4 months ago

Thought: In general, I would recommend using the Starter Pack's implementation over this, as it provides a VENV and the current rules every time it's run. I think it's also relatively unlikely that anyone will use Vale from this repository specifically, as there's no real links to this repository outside of the not-very-well-socialised style guide.

I agree for those using Sphinx - but remember that we have a lot of documentation in Discourse and on other platforms as well, and there using the starter pack doesn't make sense.

SecondSkoll commented 4 months ago

Thought: In general, I would recommend using the Starter Pack's implementation over this, as it provides a VENV and the current rules every time it's run. I think it's also relatively unlikely that anyone will use Vale from this repository specifically, as there's no real links to this repository outside of the not-very-well-socialised style guide.

I agree for those using Sphinx - but remember that we have a lot of documentation in Discourse and on other platforms as well, and there using the starter pack doesn't make sense.

I suppose, but the starter pack also gives you access to our other doc validation tools. I guess it'll be case by case though.

ru-fu commented 4 months ago

I suppose, but the starter pack also gives you access to our other doc validation tools. I guess it'll be case by case though.

Which is why I think the validation logic should be moved out of the starter pack Makefile and into our workflows repo. ;)