Skip to content

[Doc]: users/explain bare index looks bad #25493

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

Closed
jklymak opened this issue Mar 18, 2023 · 5 comments
Closed

[Doc]: users/explain bare index looks bad #25493

jklymak opened this issue Mar 18, 2023 · 5 comments
Milestone

Comments

@jklymak
Copy link
Member

jklymak commented Mar 18, 2023

Documentation Link

https://matplotlib.org/devdocs/users/explain/index.html

Problem

This is very bare bones, and could be substantially improved

  • figures?
  • A bit of introduction to what the section is meant to do.
  • visual elements for the different sections?

Suggested improvement

No response

@jklymak jklymak added this to the v3.8.0 milestone Mar 18, 2023
@Higgs32584
Copy link
Contributor

do you want it similar to this fashion?

https://matplotlib.org/stable/tutorials/index.html

@story645
Copy link
Member

What about expanding to second level? I landed on this issue b/c I was frustrated that I couldn't find the annotation tutorial because it's now buried under 3 levels.

@jklymak
Copy link
Member Author

jklymak commented May 30, 2023

@story645 For sure, https://matplotlib.org/devdocs/users/index.html and https://matplotlib.org/devdocs/users/explain/index.html should be fixed.

#24493 actually had a bunch of reasonable ideas. I think we should not over-stress about it, and just choose one and go with it. Nothing is perfect, and we will never get 100% consensus on these things, but most of the ideas in there were better than the status quo. If you wanted to pick one that was relatively comprehensive, we can try it for a while and tweak later. We should get something in soonish so we can live with it for a while before the release (Aug?)

FWIW, I like the idea of having graphics on these pages. There are lots of thumbnails already in the docs that we can use to visually guide the reader.

@rcomer
Copy link
Member

rcomer commented Jul 1, 2023

Was this addressed by #26110?

@jklymak jklymak closed this as completed Jul 1, 2023
@jklymak
Copy link
Member Author

jklymak commented Jul 1, 2023

Yep!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants