Doc user guide cards #26105
Doc user guide cards #26105
Conversation
8c3b14b to
a4c51c9
Compare
doc/users/index.rst
Outdated
| faq/index.rst | ||
| resources/index.rst | ||
| ../api/index.rst | ||
| ../devel/index.rst |
There was a problem hiding this comment.
Can this go into the information card? It feels out of place in the reference/example card.
doc/users/index.rst
Outdated
| explain/index.rst | ||
| faq/index.rst | ||
| resources/index.rst | ||
| ../api/index.rst |
There was a problem hiding this comment.
Can this go at the end of this list?
doc/users/index.rst
Outdated
| ../devel/index.rst | ||
| project/index.rst | ||
| release_notes.rst | ||
| release_notes.rst |
There was a problem hiding this comment.
This is on the top level, so I think making it two levels is kinda cluttering it here.
doc/users/index.rst
Outdated
| getting_started/index.rst | ||
| installing/index.rst | ||
| faq/index.rst | ||
| resources/index.rst |
There was a problem hiding this comment.
Thanks for moving the other stuff, I think this should also be moved to maybe the tutorials/plot types/example section as it's I think mostly external tutorials and tools & probably overkill for a get started.
doc/users/index.rst
Outdated
|
|
||
| .. raw:: html | ||
|
|
||
| <div class="grid__intro" id="image_rotator"></div> |
There was a problem hiding this comment.
For this one, would the anatomy image/a semi stripped down form be a good anchor or intimidating? I generally really like the idea of anchoring these two sections with images, but for this one in particular think maybe a single explanatory image may make more sense?
There was a problem hiding this comment.
For this one, would the anatomy image/a semi stripped down form be a good anchor or intimidating?
I think the actual anatomy would be too busy. But I've taken the spirit of this, and added a "simple plot" that has a few lines, and some scatter on it.
|
Outside of scope here, bit would it make sense maybe to push the rotator out to mpl-sphinx-theme? |
|
Outside of scope here, bit would it make sense maybe to push the rotator out to mpl-sphinx-theme? Eta: also this is gonna make me sound super indecisive but now I think resources should maybe be moved back and the FAQ moved out somewhere, but I think that's probably cause scope is a bit fuzzy. |
I think the organization could go many ways, but I think it's fair to think of the External Resources as more "Examples and Tutorials", which they largely are. FAQ and troubleshooting in the top card also makes sense to me as something folks need quite often. We can always try this for a while and then follow up. |
PR summary
This organizes the ToC for https://matplotlib.org/devdocs/users/index.html using grids and adds a rotator for images in a couple of the shorter grids.
I changed the ToC depth for things that already have top-level nabber links as those are prominent enough.
Current:
Proposed. EDIT: newest version
PR checklist