Standards for linting and proofing documents in [#technical-documentation]

LinkORB has the following requirements for linting and proofing technical documents:

Use Vale.sh to proofread your content

Vale.sh makes evaluating your document for spelling, grammar, and style very easy.

Installation and usage instructions can be found in Edit Markdown documents with Vale.

Fix Markdown syntax and style errors

Use markdownlint and remarklint to check for style and syntax issues in Markdown documents. Please see Lint Markdown documents for installation and usage instructions.

Scan and fix broken links

Run linkinator or muffet against the development server to find and fix broken links. See scan for broken links in web applications for installation and usage instructions.