docs: document markdownlint

What does this MR do?

This documents how and why we use markdownlint and recommends configuring a code editor to report violations.

Closes #1460 (closed)