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

Revise the graphics used in README for vizro-ai and vizro-core so they render better in PyPI #380

Open
stichbury opened this issue Mar 20, 2024 · 0 comments
Labels
Good first issue Good first issue for beginners Status: Help Wanted 🙏 Issue/PR needs extra attention

Comments

@stichbury
Copy link
Contributor

stichbury commented Mar 20, 2024

This is a good issue for someone with design knowledge or who knows how to optimally set out graphics to work on different GitHub themes and on PyPI. It touches docs but doesn't change any wording. No knowledge of Vizro is required.

https://pypi.org/project/vizro/
image

and https://pypi.org/project/vizro-ai/
image

both look a bit rubbish right now because of the graphics choice in our package README files.

We need to revise these to work better, or make separate choices for PyPI. This is a potential good first issue for a contributor to Vizro if they have previous experience with PyPI page submissions. The remit is that the graphic/GIF should work in light/dark mode and on GitHub plus PyPI.

@stichbury stichbury added Status: Help Wanted 🙏 Issue/PR needs extra attention Component: Docs 🗒️ Issue/PR for markdown and API documentation Good first issue Good first issue for beginners and removed Component: Docs 🗒️ Issue/PR for markdown and API documentation labels Mar 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Good first issue Good first issue for beginners Status: Help Wanted 🙏 Issue/PR needs extra attention
Projects
None yet
Development

No branches or pull requests

1 participant