search

jazzband / pip-tools

A set of tools to keep your pinned Python dependencies fresh.
https://pip-tools.rtfd.io
BSD 3-Clause "New" or "Revised" License
7.74k stars 612 forks source link

README diagram does not display well on dark mode #1313

Closed johnthagen closed 3 years ago

johnthagen commented 3 years ago
  1. Enable GitHub Dark Mode: https://github.com/settings/appearance
  2. Open the pip-tools GitHub page
Screen Shot 2021-02-01 at 7 28 07 AM

Perhaps if the black text had a white outline it would help?

atugushev commented 3 years ago

Hello @johnthagen,

Nice catch! Yes, indeed. White outlined labels would look better on a dark mode.

fhightower commented 3 years ago

I'd like to address this issue. @atugushev: Do you mind assigning the issue to me?

webknjaz commented 3 years ago

@fhightower feel free to send a PR, I've marked you as an assignee.

webknjaz commented 3 years ago

@fhightower while you're on it, I have a comment to make. I don't like that the picture is PNG. It's much better to have it in SVG. So could you redraw it in vector and keep it in that format?

webknjaz commented 3 years ago

Also, verify the colors compat/contrast with more than one dark theme — GH has two darks (default and dimmed), and also, there are third-party mods like https://github.com/StylishThemes/GitHub-Dark.

fhightower commented 3 years ago

Will do, thanks for the input.

webknjaz commented 3 years ago

FTR now that there's Sphinx docs including README, we need to also check https://pip-tools.rtfd.io (there's a dark mode toggle at the top-right corner).

fhightower commented 3 years ago

I've started working on this and want to get some feedback before going further. I've replicated the current image in an SVG you can see here. I have two questions:

  1. I'd like to make the background grey. Any objections or alternative suggestions?
  2. Any other suggestions, comments, or concerns about the current image?

Thanks!

webknjaz commented 3 years ago

@fhightower that is no longer necessary because this will be closed by #1475. @peymanslh did the work and it's almost ready for merge.

For the future, it's best to start PRs — they are how people get feedback/reviews/discussions on GitHub. If there's no PR, the assumption is that nobody's working on the issue.

fhightower commented 3 years ago

Ah, ok - thanks for the feedback @webknjaz .