doc: introduce icon policy documentation by jarolrod · Pull Request #70 · bitcoin-core/gui-qml

jarolrod · 2021-10-26T05:58:15Z

This introduces documented policies for how icons should be prepared, optimized, styled, contributed, and attributed within Bitcoin Core. Having guidelines for iconography helps with making applications more consistent and efficient.

document render

jarolrod · 2021-10-26T17:57:02Z

cc @Bosch-0 @GBKS

Bosch-0

Could we not have that PNG optimization tool run automatically when an image / icon is added to the repo?

promag · 2021-10-27T08:48:06Z

@Bosch-0 where would it run automatically? We don't want non-optimized icons in the source tree so the command would have to run client-side. I think you could configure a pre-commit hook in your git client to do this automatically but maybe not worth the effort.

promag

Concept ACK.

promag · 2021-10-27T09:03:47Z

+
+#### SVG Source File
+SVGs are used as source files because they can scale while retaining image quality.
+They are not used in production due to limited application support.


Do you have an example of limited app support?

This line was originally written by @Bosch-0

I can think of 2 motivations:

From https://doc.qt.io/qt-5/svgrendering.html:

Qt supports the static features of SVG 1.2 Tiny. ECMA scripts and DOM manipulation are currently not supported.

rendering an SVG in a small size might not produce a good-looking icon and so it is easier to have a PNG optimized for that size.

Limited app support may be too harsh, not as widely supported as PNG is probably a better way to put it. JPEG files should also be used over SVGs for images with wider color profiles.

The phrase “limited application support.” sounds a little confusing and might be misleading. For example, one might think, which application are we talking about here? Is it “bitcoin core” or some other application that works on PNG, SVG, and other formats of images.

I think a better framing of this sentence would be:
“They are not used in production because they are not widely supported (compared to PNGs).”

In this framing, the reader will clearly understand that we are talking about format support in general.

This line is just a quick explanation as to why we are not using SVG files as our production files. The reason for this is because of limited application support; this could refer to x, y, or z reason.

In reality, we are/will be using SVG as production files because that is what designers have recommended. Getting into the particularities here, or what the reality of support for SVG files really is across all applications doesn't matter.

@shaavan: Changing from "limited application support" to "not widely supported" doesn't remove the inherent reference to 'outside' projects

I think the line is fine as is

Changing from "limited application support" to "not widely supported" doesn't remove the inherent reference to 'outside' projects

I can see what you are talking about. I guess the phrase "limited application support" is not as confusing as I first perceived it to be :)

jarolrod · 2021-10-27T23:51:33Z

Updated from 8a2c366 -> 23ad199

Changes: addressed @promag comment

hebasto

Concept ACK.

hebasto · 2021-10-30T07:04:50Z

+and text chunks, resulting in a lossless reduction of the file's size.
+
+## Contributing
+Bitcoin Core primarily uses icons from the [Bitcoin Icon set](https://github.com/BitcoinDesign/Bitcoin-Icons),


In the current state of this repo no icons are from the Bitcoin Icon set, right? Maybe clarify that new added icons should be chosen from that set?

We will be using those Icons. Although there are none yet, they will be added as needed. We know that we will primarily use these icons. I don't see the need to state, as of right now, that "new" icons will be chosen from the set.

shaavan

Concept ACK

The icon policy documentation is quite nicely arranged. The details in the document are pretty well explained without being overwhelming. This writing style fulfills the purpose of the documentation as it would be used chiefly by newcomers in the bitcoin core contributing ecosystem.

I have one change to suggest, which I have mentioned here. Other than this and other minor changes suggested by other reviewers, I think this documentation is perfect!

jarolrod · 2021-11-01T21:51:51Z

Updated from 23ad199 -> 68efd37 (pr70.02 -> pr70.03, diff)

Changes:

Correct grammar on line talking about file size reduction: doc: introduce icon policy documentation #70 (comment)
s/"ancillary (alla)"/"ancillary data": doc: introduce icon policy documentation #70 (comment)
Update link to copyright file from pointing to the old gui repo to this (qml-gui) repo

Bosch-0 · 2021-11-02T01:49:22Z

ACK from me :)

hebasto

ACK 68efd37

shaavan

ACK 68efd37

Thanks again for this fantastic work, @jarolrod!

promag

ACK 68efd37.

+1 to @hebasto comment though.

Co-authored-by: jarolrod <jarolrod@tutanota.com>

jarolrod · 2021-11-02T16:37:37Z

updated from 68efd37 -> 7335bdd (pr70.03 -> pr70.04 ,diff)

Changes: addressed @hebasto comment

hebasto

re-ACK 7335bdd

Co-authored-by: jarolrod <jarolrod@tutanota.com> Github-Pull: bitcoin-core#70 Rebased-From: 7335bdd

Github-Pull: bitcoin-core#70 Rebased-From: 7335bdd Co-authored-by: jarolrod <jarolrod@tutanota.com>

40e6a0e doc: introduce icon policy documentation (bosch) Pull request description: Moved from bitcoin-core/gui#310 Picking up bitcoin-core/gui#178 This introduces documented policies for how icons should be prepared, optimized, styled, contributed, and attributed within Bitcoin Core. Having guidelines for iconography helps with making applications more consistent and efficient. [document render](https://github.com/bitcoin-core/gui-qml/blob/23ad199b43e9068d0571eba5965752b03842a7f4/src/qml/doc/icon-policy.md) ACKs for top commit: hebasto: re-ACK 40e6a0e Tree-SHA512: aebdfcfea83d23584ccbcf7bdb706bcddfd63dbdb53018ec8220cab87cc92720fd41cb532325e258fff6bcc53b5cebbe498fba2ad95ebebb5da4f868f92607d3

40e6a0e8a279323cf941ff0bde38fd34fcc0f445 doc: introduce icon policy documentation (bosch) Pull request description: Moved from bitcoin-core/gui#310 Picking up bitcoin-core/gui#178 This introduces documented policies for how icons should be prepared, optimized, styled, contributed, and attributed within Bitcoin Core. Having guidelines for iconography helps with making applications more consistent and efficient. [document render](https://github.com/bitcoin-core/gui-qml/blob/23ad199b43e9068d0571eba5965752b03842a7f4/src/qml/doc/icon-policy.md) ACKs for top commit: hebasto: re-ACK 40e6a0e8a279323cf941ff0bde38fd34fcc0f445 Tree-SHA512: aebdfcfea83d23584ccbcf7bdb706bcddfd63dbdb53018ec8220cab87cc92720fd41cb532325e258fff6bcc53b5cebbe498fba2ad95ebebb5da4f868f92607d3

jarolrod mentioned this pull request Oct 26, 2021

Introduce Icon Policy Documentation bitcoin-core/gui#310

Closed

hebasto added the Doc Improvements or additions to documentation label Oct 26, 2021

Bosch-0 reviewed Oct 27, 2021

View reviewed changes

promag reviewed Oct 27, 2021

View reviewed changes

jarolrod force-pushed the icon-policy-doc branch from 8a2c366 to 23ad199 Compare October 27, 2021 23:50

hebasto added the UX Designers' opinions are required label Oct 30, 2021

hebasto reviewed Oct 30, 2021

View reviewed changes

shaavan reviewed Nov 1, 2021

View reviewed changes

jarolrod force-pushed the icon-policy-doc branch from 23ad199 to 68efd37 Compare November 1, 2021 21:47

hebasto approved these changes Nov 2, 2021

View reviewed changes

Comment thread src/qml/doc/icon-policy.md Outdated

shaavan approved these changes Nov 2, 2021

View reviewed changes

promag reviewed Nov 2, 2021

View reviewed changes

doc: introduce icon policy documentation

7335bdd

Co-authored-by: jarolrod <jarolrod@tutanota.com>

jarolrod force-pushed the icon-policy-doc branch from 68efd37 to 7335bdd Compare November 2, 2021 16:35

hebasto approved these changes Nov 2, 2021

View reviewed changes

hebasto merged commit 000ff6b into bitcoin-core:main Nov 2, 2021

hebasto pushed a commit to hebasto/gui-qml that referenced this pull request Jun 6, 2025

doc: introduce icon policy documentation

15a1495

Co-authored-by: jarolrod <jarolrod@tutanota.com> Github-Pull: bitcoin-core#70 Rebased-From: 7335bdd

hebasto pushed a commit to hebasto/gui-qml that referenced this pull request Jun 7, 2025

doc: introduce icon policy documentation

83e2a7b

Co-authored-by: jarolrod <jarolrod@tutanota.com> Github-Pull: bitcoin-core#70 Rebased-From: 7335bdd

hebasto pushed a commit to hebasto/gui-qml that referenced this pull request Jun 7, 2025

doc: introduce icon policy documentation

2889105

Github-Pull: bitcoin-core#70 Rebased-From: 7335bdd Co-authored-by: jarolrod <jarolrod@tutanota.com>

hebasto pushed a commit to hebasto/gui-qml that referenced this pull request Jun 8, 2025

doc: introduce icon policy documentation

deb0b5a

Github-Pull: bitcoin-core#70 Rebased-From: 7335bdd Co-authored-by: jarolrod <jarolrod@tutanota.com>

hebasto pushed a commit to hebasto/gui-qml that referenced this pull request Jun 8, 2025

doc: introduce icon policy documentation

ef8370d

Github-Pull: bitcoin-core#70 Rebased-From: 7335bdd Co-authored-by: jarolrod <jarolrod@tutanota.com>

hebasto pushed a commit to hebasto/gui-qml that referenced this pull request Jun 9, 2025

doc: introduce icon policy documentation

2f7e39f

Github-Pull: bitcoin-core#70 Rebased-From: 7335bdd Co-authored-by: jarolrod <jarolrod@tutanota.com>

hebasto pushed a commit to hebasto/gui-qml that referenced this pull request Jun 9, 2025

doc: introduce icon policy documentation

a065445

Github-Pull: bitcoin-core#70 Rebased-From: 7335bdd Co-authored-by: jarolrod <jarolrod@tutanota.com>

Conversation

jarolrod commented Oct 26, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jarolrod commented Oct 26, 2021

Uh oh!

Bosch-0 left a comment

Choose a reason for hiding this comment

Uh oh!

promag commented Oct 27, 2021

Uh oh!

promag left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

jarolrod commented Oct 27, 2021

Uh oh!

hebasto left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

shaavan left a comment

Choose a reason for hiding this comment

Uh oh!

jarolrod commented Nov 1, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Bosch-0 commented Nov 2, 2021

Uh oh!

hebasto left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

shaavan left a comment

Choose a reason for hiding this comment

Uh oh!

promag left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jarolrod commented Nov 2, 2021

Uh oh!

hebasto left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

jarolrod commented Oct 26, 2021 •

edited

Loading

jarolrod commented Nov 1, 2021 •

edited

Loading

promag left a comment •

edited

Loading