From 4b70d55301d6abd031b39f39bc9106aa70a5891b Mon Sep 17 00:00:00 2001 From: Evan Read <eread@gitlab.com> Date: Thu, 21 Jul 2022 15:57:11 +0000 Subject: [PATCH] Vale errors should include anything that affects docs site rendering --- doc/development/documentation/testing.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/doc/development/documentation/testing.md b/doc/development/documentation/testing.md index d55cbe28d9bac..5dd7235917ad7 100644 --- a/doc/development/documentation/testing.md +++ b/doc/development/documentation/testing.md @@ -250,7 +250,8 @@ You can use Vale: Vale returns three types of results: -- **Error** - For branding and trademark issues, and words or phrases with ambiguous meanings. +- **Error** - For branding and trademark issues, words or phrases with ambiguous meanings, and anything that causes content on + the docs site to render incorrectly. - **Warning** - For Technical Writing team style preferences. - **Suggestion** - For basic technical writing tenets and best practices. -- GitLab