Administration: Content Quality

PR Validation Checklist

1. Check that any new files names are descriptive and useful
2. Check that article titles are useful/descriptive
3. Check that images are as small as possible
   • prefer jpg over png
   • Show the minimum image to demonstrate the point
   • images >100KB should be questioned.
4. Check (in particular) that home pages have not been edited with evil intent
5. Check that pages that have been deleted do not contain the toctree directive, as this will hide sub pages.
6. Build the doc source and sanity check.

Link checking

You can run a link checker at build time using sphinx. To do this, navigate to the sub project you want to check (the directory which has the conf.py file in it) and run

make linkcheck

A link report will be created in /build/linkcheck/output.txt