Documentation Office Hours recording 5th April 2024

Vale and testing

In this recording, we discuss and demo some of our documentation testing tools and frameworks.

Huge thank you to @avgomes_u and @rkratky for putting this all together, and for the live demos.

Let us know your own thoughts on documentation testing in the comments!

00:00 Intro
00:45 Docs Starter Pack
02:28 Makefile
04:20 Command-line demo
05:10 make linkcheck
06:00 make spelling
08:34 Docs checks as GitHub Actions
12:45 Vale
14:45 Vale config generator
15:30 Andreia & vale
16:25 Contractions check
18:20 Vale demo
20:35 VS Code & vale
22:00 Q&A

We record a new Documentation Office Hours every Friday.

Further information

Documentation validation

Other stuff