mckinsey / vizro

Vizro is a toolkit for creating modular data visualization applications.
https://vizro.readthedocs.io/en/stable/
Apache License 2.0
2.46k stars 109 forks source link

[Docs] Two small docs changes for improved usability #477

Closed stichbury closed 1 month ago

stichbury commented 1 month ago

Description

Following discussion with @antonymilne

Screenshot

Notice

antonymilne commented 1 month ago

Thanks for following up on these things! Definitely a good improvement.

I still find the repetition of "Examples" in the left-hand menu a bit jarring, especially since it doesn't match the title of the page (unlike the "Examples from vizro users" page, which does). So if you can figure out a nicer way to do that it would be great 😀 image Maybe we should even just put this all in one page for now instead of splitting it up? Up to you.

Add a mention of Plotly community forums. Have I got the right category @antonymilne ?

Yes, looks good!

TBH that whole contribution guide needs a solid revision and I have this on my list, just not yet, so if it makes sense to do so, I can park this change for now and add it in later. Alternatively, we could put something about these forums behind a "Got a question?" link on the front page of the docs, and point straight through to the Plotly forums there, so it's really obvious. LMK if you'd like to try that and see how many queries get raised.

I like this idea! The link is definitely quite buried at the moment so would be interesting to see if there's more posts there if we put it on the front page. Or we could have a shortcut from our docs front page to the section of the contribution guidelines which suggest asking a general question on Github issues or the plotly forums. Like you say, the contribution guidelines in general are in need of a revision, and probably people should be able to find where they can ask questions without considering it a "contribution". Very happy to leave perfecting this for future changes, and for now it's useful to just have a quick and easy change to make more obvious what our two support routes are (Github issues, plotly forums) however you think is best to do so.

stichbury commented 1 month ago

I still find the repetition of "Examples" in the left-hand menu a bit jarring, especially since it doesn't match the title of the page (unlike the "Examples from vizro users" page, which does). So if you can figure out a nicer way to do that it would be great 😀

That's a really good point. I've made a slight change to the title and the table of contents listing, so now it looks as follows:

Screenshot 2024-05-14 at 09 42 00

It's probably still a bit repetitive but I've retained the intent to make it obvious that there are two separate pages, and I think we should keep to that because one will become an "awesome" list at some point (and ideally put into a separate repo or hosted in GitHub rather than docs) while the other page is more a description of what we provide in the repo or as official examples.