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

Add favicon and changelogs #323

Merged
merged 8 commits into from
Feb 21, 2024
Merged

Add favicon and changelogs #323

merged 8 commits into from
Feb 21, 2024

Conversation

stichbury
Copy link
Contributor

@stichbury stichbury commented Feb 20, 2024

Description

Added vizro favicon per #314

Yay, it's working: https://vizro-ai--323.org.readthedocs.build/en/323/ as an example

WDYT @Joseph-Perkins ?

Screenshot

Notice

  • I acknowledge and agree that, by checking this box and clicking "Submit Pull Request":

    • I submit this contribution under the Apache 2.0 license and represent that I am entitled to do so on behalf of myself, my employer, or relevant third parties, as applicable.
    • I certify that (a) this contribution is my original creation and / or (b) to the extent it is not my original creation, I am authorized to submit this contribution on behalf of the original creator(s) or their licensees.
    • I certify that the use of this contribution as authorized by the Apache 2.0 license does not violate the intellectual property rights of anyone else.
    • I have not referenced individuals, products or companies in any commits, directly or indirectly.
    • I have not added data or restricted code in any commits, directly or indirectly.

Signed-off-by: Jo Stichbury <[email protected]>
@stichbury stichbury added the Docs 🗒️ Issue for markdown and API documentation label Feb 20, 2024
@stichbury stichbury self-assigned this Feb 20, 2024
Signed-off-by: Jo Stichbury <[email protected]>
Signed-off-by: Jo Stichbury <[email protected]>
@stichbury stichbury changed the title [draft] Add favicon and changelogs Add favicon and changelogs Feb 20, 2024
@stichbury stichbury marked this pull request as ready for review February 20, 2024 14:47
Signed-off-by: Jo Stichbury <[email protected]>
Copy link
Contributor

@huong-li-nguyen huong-li-nguyen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here are the official images for vizro from branding: https://mckinsey.atlassian.net/wiki/spaces/VIZX/pages/577798204/Branding

I would use this one for the favicon - Vizro_IconOnly_TransparentBG.svg: https://mckinsey.box.com/s/tvb8dt9l4cblqs2sd19bu3vfb9uv5j6m

It's also the favicon we use for the hosted app :)

Copy link
Contributor

@antonymilne antonymilne left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

favicon looks great to me 👍 And agree that we should leave the logo alone for now and in the future make our docs more vizro-themed (vizriffic?) and figure out the right colour for it then.

FYI our setup for generating changelogs is basically optimised for people who only edit one package (vizro-ai or vizro-core) at a time, which is the case in 95% of PRs. If you end up editing both of them simultaneously a lot then you might like to make some alias for a command that does it for you:

cd vizro-core; hatch run changelog:add; cd ../vizro-ai; hatch run changelog:add; cd ..

So far we haven't been putting docs changes in our changelog at all (which I think is correct, but happy to discuss if you feel otherwise), so chances are high that you'll just need to leave this file empty every time.

@stichbury
Copy link
Contributor Author

Merging this and I've found and commented on a ticket for future Design work on the docs.

@stichbury stichbury merged commit 62b61ec into main Feb 21, 2024
34 checks passed
@stichbury stichbury deleted the add-favicon branch February 21, 2024 10:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs 🗒️ Issue for markdown and API documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants