From 6e9055f4e8500e4e2cd35bc72a007650f23e8294 Mon Sep 17 00:00:00 2001 From: Nathan Lovato Date: Fri, 21 Aug 2020 10:26:10 -0600 Subject: [PATCH] Edit docs_writing_guidelines Tweaked some sentences to remove parentheses Turned the note about pngquant into a note box --- .../contributing/docs_writing_guidelines.rst | 18 +++++++++++------- 1 file changed, 11 insertions(+), 7 deletions(-) diff --git a/community/contributing/docs_writing_guidelines.rst b/community/contributing/docs_writing_guidelines.rst index 9d2bd4c3a..954c9ae2a 100644 --- a/community/contributing/docs_writing_guidelines.rst +++ b/community/contributing/docs_writing_guidelines.rst @@ -519,13 +519,17 @@ connections. When you need to highlight an area of the editor to show something, like a button or option, use a 2 pixel-thick yellow outline without a bevel. If the -outline is on a dark background, the outline should be yellow (*not* red) so it -can be easily seen by colorblind people. +outline is on a dark background, the outline should be yellow so it can be +easily seen by colorblind people. Please do not use red as it won't be visible +for some users. Before you add or replace any images in the documentation, they should be run through a PNG compressor to save size. You can use the lossless OxiPNG -compressor included in `Squoosh `__ for this purpose. -For heavier images, also look into using a lossy compressor, such as -`pngquant `_ where almost no image quality is lost -during compression. (This compressor must be installed locally as it's -not available in Squoosh.) +compressor included in `Squoosh `__ for this purpose. For +heavier images, consider using a lossy compressor like `pngquant +`_. With it, almost no image quality is lost during +compression. + +.. note:: + + The program pngquant must be installed locally as it's not available in Squoosh.