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

organize navbar in overview->details order #72

Merged
merged 2 commits into from
Sep 13, 2023
Merged

Conversation

story645
Copy link
Member

@story645 story645 commented May 2, 2023

Um this is a first pass rather than something I'm strongly attached to, but I'm proposing the following story right to left because it goes from overview of the library to details on demand. I continue to not really know where to place tutorials but the middle kinda makes sense

  • plot types -> user guide -> tutorials -> examples -> reference

Um this is a first pass rather than something I'm strongly attached to, but I'm proposing the following story right to left because it goes from overview of the library to details on demand. I continue to not really know where to place tutorials but the middle kinda make sense

- plot types -> user guide -> tutorials -> examples -> reference
@story645 story645 added the navbar label May 2, 2023
@timhoffm
Copy link
Member

Ok by me. But note that the User Guide page cuurently is more a global TOC and contains the others. By content I'd does not fit in an overview -> detail order. But that's a more general issue of our general sphinxpage hierarchy..

@story645
Copy link
Member Author

By content I'd does not fit in an overview -> detail order. But that's a more general issue of our general sphinxpage hierarchy.

Agreeish but @jklymak especially has been putting a lot of work into making it more overviewish.

@timhoffm
Copy link
Member

Agreeish but @jklymak especially has been putting a lot of work into making it more overviewish.

I know and appreciate that. We've had detailed discussions. At some point we decided to merge the current state. It's already much better than before. I'm just reminding that there is still work to be done. And the intended ordering of this PR is not yet reflected by the content behind the menu title "User guide".

Co-authored-by: Elliott Sales de Andrade <[email protected]>
@story645
Copy link
Member Author

So the reason I put the order as user guide->tutorials is b/c of the getting started section of the user guide:

image

And the intended ordering of this PR is not yet reflected by the content behind the menu title "User guide".

I tried to make the overviewish nature clearer in matplotlib/matplotlib#24493 and I'd now probably advocate for some kinda top level table/roadmap that groups things into something like "Start->Build->Customize" + Project info + remove contribute since it's in the nav bar.

@story645
Copy link
Member Author

story645 commented Aug 8, 2023

Ping again on this? Especially since #26332 went in so the user guide is no longer global toc?

Copy link
Member

@QuLogic QuLogic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks like the User guide does seem overview-y now, so this seems good.

@QuLogic QuLogic merged commit 2ed4649 into matplotlib:main Sep 13, 2023
@story645 story645 deleted the navbar branch September 13, 2023 20:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants