From 55f242355d732b50f0df303a220db0d7c78610d8 Mon Sep 17 00:00:00 2001 From: stephffuller Date: Wed, 12 Aug 2020 17:51:27 -0400 Subject: [PATCH] Update style-guide.md --- .github/style-guide.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/style-guide.md b/.github/style-guide.md index 48d3bd90..084c42f7 100644 --- a/.github/style-guide.md +++ b/.github/style-guide.md @@ -47,12 +47,12 @@ The following sections provide general guidelines on topics specific to Redocly ### General * Use active voice. Avoid passive voice. - - Passive: The heatmap visualization is displayed. - - Active: Redocly displays the heatmap visualization. + - Passive: The page is displayed. + - Active: Redocly displays the page. * Write in the imperative second person. Examples: You can write an API. Click the panel. Close the window. * Write in present tense. - Not: The rule will check content. - - Use: The checks content. Redocly checks the content. + - Use: The rule checks content. Redocly checks the content. * Do not use an ampersand (&) as an abbreviation for "and." - **Exceptions:** If an ampersand is used in the Redocly UI, then match the UI. * Avoid using internal slang and jargon in technical documentation.