From 1d931b18f3567a5c9cc1b283ceddcb0c60643457 Mon Sep 17 00:00:00 2001 From: Chris Holdgraf Date: Thu, 31 Jan 2019 11:24:00 -0800 Subject: [PATCH] updating the image size text --- docs/contributing/docs.rst | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/docs/contributing/docs.rst b/docs/contributing/docs.rst index f5a7549..e1429d4 100644 --- a/docs/contributing/docs.rst +++ b/docs/contributing/docs.rst @@ -199,11 +199,18 @@ Our policy for new features is: All new features must have appropriate documentation before they can be merged. -Minimizing images -================= +Choosing image size +=================== -Optimize image compression where possible. For PNG files, use OptiPNG and -AdvanceCOMP's ``advpng``: +When adding images to the documentation, try to keep them as small as possible. +Larger images make the site load more slowly on browsers, and may make the site +inaccessible for people with a slow internet connection. + +If you're adding screenshots, make the size of your shot as small as possible. +If you're uploading large images, consider using an image optimizer in order +to reduce its size. + +For example, for PNG files, use OptiPNG and AdvanceCOMP's ``advpng``: .. code-block:: console