writethedocs / www

The main website for Write the Docs.
http://www.writethedocs.org
Other
1.32k stars 508 forks source link

Automate this check #1962

Closed plaindocs closed 1 year ago

plaindocs commented 1 year ago

Inspired by #1961 I added the check to vale:

❯ vale docs

 docs/conf/australia/2022/news/thank-you-recap.rst
 19:85  error  Use 'Write the Docs' instead    WTD.Branding 
               of 'Write The Docs'                          

 docs/slack.rst
 213:8  error  Don't say 'black sheep'  WTD.inclusivity-avoid 

✖ 2 errors, 0 warnings and 0 suggestions in 1348 files.

I'm not sure why the first one hasn't triggered our CI though?


:books: Documentation preview :books:: https://writethedocs-www--1962.org.readthedocs.build/

plaindocs commented 1 year ago

OK, it is detecting it, but returning success regardless

image

So something is misconfigured.

(Black sheep has already been removed on main)

plaindocs commented 1 year ago

Success

image