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

Restyle the documentation landing page #378

Closed
stichbury opened this issue Mar 20, 2024 · 5 comments
Closed

Restyle the documentation landing page #378

stichbury opened this issue Mar 20, 2024 · 5 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 anyone with markdown experience who enjoys the styling/design aspect rather than writing copy. There's no knowledge of Vizro required.

The current landing page for documentation is rather bland https://vizro.readthedocs.io/en/stable/ and the presentation could potentially be improved.

It would be great to have some styling to improve it. We can start with the copy we have (although we do need to add a section to link to the demo example in the repo). Some basic redesign is all that is needed to boost the look and feel.

@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 labels Mar 20, 2024
@stichbury stichbury removed the Component: Docs 🗒️ Issue/PR for markdown and API documentation label Mar 21, 2024
@sulphatet
Copy link
Contributor

Hi, I would like to work on this, can this be assigned to me?

@stichbury
Copy link
Contributor Author

Thank you for volunteering! We are making a few changes throughout our docs but one thing you could do, if you were interested in helping with changing the look of the docs, is to update the font across the docs to use Inter. We only use Inter regular, medium and semi-bold.

If you wanted to look at the relevant CSS changes for Vizro and Vizro-AI docs to replace the existing font with that one, and if you felt confident about doing that, we are happy to accept a contribution of that change. Beyond that, for now, we are going to pause any changes subject to some guidance from our design team.

WDYT? Would you like to give it a try? Thanks @sulphatet!

@sulphatet
Copy link
Contributor

Hi @stichbury
Yes! I would love to work on that.

From what I understand, I should be updating vizro-core/docs/stylesheets/extra.css and vizro-ai/docs/stylesheets/extra.css, is that right?

Thanks!

@stichbury
Copy link
Contributor Author

I think it may be more straightforward than that, since we're using MkDocs Material theme. You can use https://squidfunk.github.io/mkdocs-material/setup/changing-the-fonts/ for guidance.

@stichbury
Copy link
Contributor Author

This is done and merged. Thanks @sulphatet ! 🌟 🏆

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

2 participants