git-machete-intellij-plugin icon indicating copy to clipboard operation
git-machete-intellij-plugin copied to clipboard

Use frontend icon files in docs

Open mkondratek opened this issue 3 years ago • 7 comments

It's different format (SVG vs PNG). For now I would rather stick to present solution (for the sake of quick release). I will create an issue to investigate and solve that redundancy.

Originally posted by @mkondratek in https://github.com/VirtusLab/git-machete-intellij-plugin/pull/864#discussion_r880344546

Now we use copies in PNG format for the docs. Try to reuse existing frontend icons.

mkondratek avatar May 24 '22 10:05 mkondratek

Can you please provide a little bit more context on this? Sorry, I am new to this topic, so I had difficulty understanding the issue.

vzmerr avatar Sep 19 '22 12:09 vzmerr

There is a redundancy in the scope of icons. We have the same icons in two formats - svg (for the plugin use) and png (for the docs). It would be nice to have them in one format only. For now it's a bit more complicated when an icon changes (for some reason. e.g. update) - we need to remember about docs. Ideally we update the icon in one place and it gets updated everywhere.

Is it clear now? :)

mkondratek avatar Sep 19 '22 12:09 mkondratek

totally clear 💯

vzmerr avatar Sep 19 '22 12:09 vzmerr

example: docs/left_bar_actions/edit.png frontend/base/src/main/resources/edit.svg

mkondratek avatar Sep 19 '22 12:09 mkondratek

I would say, since .svg is more flexible for resizing maybe we can just work with .svg

vzmerr avatar Sep 19 '22 12:09 vzmerr

+1 for svg-only; png can be easily generated out of svg if needed, but not the other way round

PawelLipski avatar Sep 19 '22 16:09 PawelLipski

TBD if svgs can be easily embedded in GitHub Markdown

PawelLipski avatar Oct 20 '22 13:10 PawelLipski