Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update the logo at README.md #35155

Merged
merged 5 commits into from
Mar 26, 2023
Merged

Update the logo at README.md #35155

merged 5 commits into from
Mar 26, 2023

Conversation

prirai
Copy link
Contributor

@prirai prirai commented Feb 18, 2023

The original logo at the README.md seems broken while accessing from GitHub's web interface. After careful consideration, I decided not to use the original black logo (at /src/doc/common/static/logo_sagemath_black.svg) due to potential disparities in its visibility when viewed by users with different display settings, such as light and dark modes. Therefore, I have update it now to use different variants for dark and light schemes.

📚 Description

📝 Checklist

  • I have made sure that the title is self-explanatory and the description concisely explains the PR.
  • I have updated the documentation accordingly.

⌛ Dependencies

Not required.

wermos and others added 2 commits February 15, 2023 12:37
Fixed the path to the Sage logo.
Updated the logo to use the svg available at - https://raw.githubusercontent.com/sagemath/artwork/master/bare_logo_sagemath.svg. The original image seems broken while accessing from GitHub's web interface.
Please tell me if this works.

After careful consideration, I decided not to use the original black logo (at /src/doc/common/static/logo_sagemath_black.svg) due to potential disparities in its visibility when viewed by users with different display settings, such as light and dark modes.
@kwankyu
Copy link
Collaborator

kwankyu commented Feb 18, 2023

I think we should consider removing the logo entirely from readme.md unless it looks as good (both in light mode and dark mode) as the numpy logo /~https://github.com/numpy/numpy

@tobiasdiez
Copy link
Contributor

This looks like a duplicate of #35142. It's also possible to show different logos for dark/light mode: https://github.blog/changelog/2021-11-24-specify-theme-context-for-images-in-markdown/

@prirai
Copy link
Contributor Author

prirai commented Feb 18, 2023

I think the blue sage logo looks fine for light and dark backgrounds.

Also, the light/dark mode might not appear well on locally installed markdown viewers which do not support GitHub flavoured markdown. @kwankyu , @tobiasdiez , does the blue logo work for now. If so, can it be merged?

If you want, I can work on a logo which is more consistent throughout. Or is a newer logo already made?

@kwankyu
Copy link
Collaborator

kwankyu commented Feb 18, 2023

This works well

<a href="https://sagemath.org">
  <picture>
    <source media="(prefers-color-scheme: dark)" srcset="src/doc/common/static/logo_sagemath_white.svg">
    <img src="src/doc/common/static/logo_sagemath_black.svg" height="60" align="left">
  </picture>
</a>   

See /~https://github.com/kwankyu/sage/tree/fix/logo

@kwankyu
Copy link
Collaborator

kwankyu commented Feb 18, 2023

If you want, I can work on a logo which is more consistent throughout. Or is a newer logo already made?

One of qualms that I have on the logo is that it consists of letters (sci-fi, this is my another qualm) but has the baseline at the bottom boundary of the image so that it does not align well with the surrounding text. The proper baseline should be that of the letters. (Because of this problem, I prefer a geometric logo. Indeed we have a geometric logo, but this logo needs work too, in my opinion)

It seems we can set a baseline to an svg image: https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/alignment-baseline You may work on this if you want to make the sage logo look better, in a new PR.

@kwankyu
Copy link
Collaborator

kwankyu commented Feb 18, 2023

This looks like a duplicate of #35142.

As this got already positive review, you may need to follow the workflow /~https://github.com/sagemath/trac-to-github/blob/master/docs/Migration-Trac-to-Github.md#for-contributing-a-change-that-addresses-an-existing-open-issue-that-already-has-a-pr-

@prirai
Copy link
Contributor Author

prirai commented Feb 19, 2023

So, I followed the link above and also got to correct my upstream and origin urls which were set incorrectly.
I ran git fetch upstream pull/35142/head:fix-link and checked out fix-link. From here I made this change:

<a href="https://sagemath.org/">
  <picture>
    <source media="(prefers-color-scheme: dark)" srcset="src/doc/common/static/logo_sagemath_white.svg">
    <img src="src/doc/common/static/logo_sagemath_black.svg" height="60" align="left">
  </picture>
</a>

After this I pushed this to my fork and then issued a pull request here: wermos#1

Did I do it correctly or I need to submit a PR here?

@kwankyu
Copy link
Collaborator

kwankyu commented Feb 19, 2023

You made a PR wermos#1 to your fork. You should force-push your local branch to prirai:develop, which is in your fork and attached to this PR.

@tobiasdiez
Copy link
Contributor

I think a pure markdown solution is better than the HTML one suggested above.

@kwankyu
Copy link
Collaborator

kwankyu commented Feb 20, 2023

Markdown solution has a drawback: https://www.stefanjudis.com/notes/how-to-define-dark-light-mode-images-in-github-markdown/#the-problem-with-non-standard-solutions

Also would the anchor work with the markdown solution?

@kwankyu
Copy link
Collaborator

kwankyu commented Feb 20, 2023

LGTM.

@prirai
Copy link
Contributor Author

prirai commented Feb 20, 2023

Imo, a universal solution (the one in HTML) is better than GitHub markdown for the points mentioned here - #35155 (comment) and here - #35155 (comment) . Does this work?

@kwankyu
Copy link
Collaborator

kwankyu commented Feb 20, 2023

Your branch works well.

@prirai
Copy link
Contributor Author

prirai commented Feb 20, 2023

Do I need to do something from my side?

@kwankyu
Copy link
Collaborator

kwankyu commented Feb 20, 2023

No.

@prirai
Copy link
Contributor Author

prirai commented Feb 20, 2023

It seems we can set a baseline to an svg image: developer.mozilla.org/en-US/docs/Web/SVG/Attribute/alignment-baseline You may work on this if you want to make the sage logo look better, in a new PR.

  • So, how should I start with this? Are we keeping the geometric logo with the sci-fi text one or either of them?
  • Also, what should be the directory of the new logo in case I start a PR now?
  • Should I use a separate branch for this?
  • Should I make the PR in the repository at - /~https://github.com/sagemath/artwork instead?

@kwankyu
Copy link
Collaborator

kwankyu commented Feb 20, 2023

  • So, how should I start with this? Are we keeping the geometric logo with the sci-fi text one or either of them?

This is experimental. Hence you keep the old ones and add new ones with their own names.

  • Also, what should be the directory of the new logo in case I start a PR now?

I suggest

src/doc/common/static/logo_sagemath_white_new.svg
src/doc/common/static/logo_sagemath_black_new.svg
  • Should I use a separate branch for this?

You always create a new local branch for a new PR.

I didn't know the existence of the repo :-) I think we experiment in this repo. Logos are something that matters to everyone. Hence if we like the new logo with baseline and want to replace the old ones with the new ones, then you should propose it to sage-devel https://groups.google.com/g/sage-devel, where people discuss and decide on developer-community-wide matters. After all this, you may optionally make another PR to the artwork repo, I think.

@kwankyu
Copy link
Collaborator

kwankyu commented Feb 20, 2023

You also need to update the PR description in the first comment, reflecting what you have really done.

@vbraun vbraun merged commit 525b34d into sagemath:develop Mar 26, 2023
@mkoeppe mkoeppe added this to the sage-10.0 milestone Mar 26, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants