search

bloomberg / memray

Memray is a memory profiler for Python
https://bloomberg.github.io/memray/
Apache License 2.0
13.17k stars 392 forks source link

Add a favicon for the docs #437

Closed mgmacias95 closed 1 year ago

mgmacias95 commented 1 year ago

Issue number of the reported bug or feature request: None

Describe your changes Add a favicon for the documentation website.

Testing performed I deployed a github pages website on my own fork: https://mgmacias95.github.io/memray/

godlygeek commented 1 year ago

This is a good idea, but I think we should be able to get a sharper image.

@pablogsal you've got an SVG of the logo kicking around somewhere, right? Cropping that to a square and then scaling down might get us something sharper, though we probably will need to crop most of the tail out - or make it wrap under the body, maybe, if we're willing to actually do some image editing...

mgmacias95 commented 1 year ago

I have PNG versions of the favicon, maybe those look slightly shaper: android-chrome-512x512 apple-touch-icon favicon-32x32

I tried multiple options but the best looking one was cropping the tail. I'm happy to do some image editing if you have other ideas.

pablogsal commented 1 year ago

@pablogsal you've got an SVG of the logo kicking around somewhere, right?

Not for memray. I only have the png image

godlygeek commented 1 year ago

OK, that's too bad. An SVG would've been really nice for trying to downscale gracefully. Ah well.

@mgmacias95 I'd like to make a different suggestion here, then. Would you mind trying to make a favicon that's just the head of the snake, and let us compare that to what you've got so far? I've mocked up this as an example of what I'm picturing:

idea 1

but I'm not actually good with photoshop, and I'm sure someone competent could greatly improve upon that. I'm thinking that focusing only on the head would let us have enough resolution at 32x32 pixels for the tongue to be visible, and I think the head is probably the most recognizable part of the logo for people, so it makes sense to spotlight that part. It might even be better to leave off even more of the body, and do something like:

idea 2

I like that even more than my first attempt (which looks a little too Loch Ness Monster in comparison 😆)

Would you mind taking this idea and running with it a bit?

mgmacias95 commented 1 year ago

Hello @godlygeek,

I made a proposal based on your suggestions. Let me know if you like it to integrate it on the PR :).

memray

Cheers, Marta

godlygeek commented 1 year ago

That looks pretty amazing to me! How does it look when scaled down to favicon size? Do we retain enough detail for it to be recognizable?

mgmacias95 commented 1 year ago

Hello @godlygeek,

I'm glad you liked it! I updated the website I deployed with the new favicon. Check it out.

Thanks!

godlygeek commented 1 year ago

Looks nice to me!

Any objections to the favicon from https://mgmacias95.github.io/memray/ @pablogsal ? If not, I'm happy to squash and land this.

pablogsal commented 1 year ago

No objections here! Great job @mgmacias95 !