godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-05 22:09:56 +03:00
Code Issues Packages Projects Releases Wiki Activity

Edit docs_writing_guidelines

Browse Source 
Tweaked some sentences to remove parentheses
Turned the note about pngquant into a note box
This commit is contained in:
Nathan Lovato
2020-08-21 10:26:10 -06:00
parent 481e7bae24
commit 6e9055f4e8
1 changed files with 11 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
community/contributing/docs_writing_guidelines.rst
View File

@@ -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 <https://squoosh.app/>`__ for this purpose.
For heavier images, also look into using a lossy compressor, such as
`pngquant <https://pngquant.org/>`_ 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 <https://squoosh.app/>`__ for this purpose. For
heavier images, consider using a lossy compressor like `pngquant
<https://pngquant.org/>`_. 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.