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

Get rid of GitHub magic in README [Quick Win] #3416

Open
astrojuanlu opened this issue Dec 12, 2023 · 8 comments
Open

Get rid of GitHub magic in README [Quick Win] #3416

astrojuanlu opened this issue Dec 12, 2023 · 8 comments
Assignees
Labels
Component: Documentation 📄 Issue/PR for markdown and API documentation Issue: Feature Request New feature or improvement to existing feature

Comments

@astrojuanlu
Copy link
Member

@marrrcin reported that he saw the README like this

image

and it's because of a bad combination of the magic we're using to detect light/dark theme

kedro/README.md

Lines 1 to 2 in 8257d55

![Kedro Logo Banner - Light](https://raw.githubusercontent.com/kedro-org/kedro/main/.github/demo-dark.png#gh-dark-mode-only)
![Kedro Logo Banner - Dark](https://raw.githubusercontent.com/kedro-org/kedro/main/.github/demo-light.png#gh-light-mode-only)

and how GitHub assumes night = dark

image

This has created other problems in the past #2961 (comment)

Given that this is broken on PyPI and half-broken on GitHub, I'd say let's get rid of this.

A strawman proposal would be something like

image

But better to have this properly designed.

@stichbury
Copy link
Contributor

Moving this to Viz as it'll be part of design initially and quite likely require web savvy too.

@stichbury stichbury added the Stage: Technical Design 🎨 Ticket needs to undergo technical design before implementation label Jan 12, 2024
@rashidakanchwala
Copy link
Contributor

@SajidAlamQB also reported this issue on pypi - https://pypi.org/project/kedro/

@astrojuanlu astrojuanlu removed the Stage: Technical Design 🎨 Ticket needs to undergo technical design before implementation label Feb 26, 2024
@astrojuanlu
Copy link
Member Author

We don't need tech design for this. We need to just do it.

@ravi-kumar-pilla
Copy link
Contributor

I encountered this when publishing github action. The way we do conditional images is deprecated. This link should help.

@astrojuanlu
Copy link
Member Author

@ravi-kumar-pilla could you check if the <picture> thing is rendered correctly on PyPI?

@ravi-kumar-pilla
Copy link
Contributor

ravi-kumar-pilla commented Mar 25, 2024

@ravi-kumar-pilla could you check if the <picture> thing is rendered correctly on PyPI?

@astrojuanlu I see an open ticket - pypi/warehouse#11251 . Needs some more searching/testing when we work on the ticket.

I tried testing the html and picture tag seems to work fine -

image

image

@astrojuanlu
Copy link
Member Author

The way to test this would be to upload a test version to https://test.pypi.org/project/kedro/ or a newly registered package only for testing purposes.

@rashidakanchwala
Copy link
Contributor

rashidakanchwala commented Aug 12, 2024

We tried to replicate this issue and it doesn't exist anymore for Readme anymore. It does exist for Pypi which we will work on fixing.

@rashidakanchwala rashidakanchwala changed the title Get rid of GitHub magic in README Get rid of GitHub magic in README [Quick Win] Aug 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: Documentation 📄 Issue/PR for markdown and API documentation Issue: Feature Request New feature or improvement to existing feature
Projects
Status: No status
Status: Todo
Development

No branches or pull requests

4 participants