Skip to content

navigation: flatten menu hierarchy #593

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
wants to merge 1 commit into from
Closed

Conversation

simon04
Copy link
Collaborator

@simon04 simon04 commented Jan 4, 2017

One says (e.g. here) that it's okay to have up to 7 menu entries. I find the current splitting rather confusing (why is "guides" not part of "documentation"?)

@SpaceK33z
Copy link
Member

Hmm, not sure about this. If later we want to add more pages then we'll need to redo something like this again.

Curious what @pastelsky and @bebraw think about this.

@bebraw
Copy link
Contributor

bebraw commented Jan 4, 2017

Losing "Documentation" category and flattening it up might not be a bad idea so 👍 from me. I'll leave the final decision to @skipjack and @pastelsky, though.

@skipjack
Copy link
Collaborator

skipjack commented Jan 4, 2017

I split it up because we were running up against the limit. Although 7 isn't really a UX issue, as your article states, we have plans to add other top-level links (e.g. to the blog) there as well. And in our setup on certain screen sizes we were starting to run up against other elements.

So as @SpaceK33z mentioned I think we would end up going back to something like this pretty quickly. What about renaming the Documentation link to Reference or otherwise re-organizing the links to address the confusion?

@simon04
Copy link
Collaborator Author

simon04 commented Jan 5, 2017

For instance: while rewriting the shimming docs, I found myself jumping around between the following pages:

  • /concepts/loaders/
  • /configuration/
  • /configuration/module/
  • /guides/shimming/
  • /loaders/
    This required using both the menu (right-aligned) and the documentation submenu (left-aligned).

Another approach would be to list /concepts, /guides also in the submenu of /documentation. Whether we then keep their top menu entries is a matter of taste.

@bebraw
Copy link
Contributor

bebraw commented Jan 5, 2017

I don't see any harm in flattening now esp. due to that jumping issue (annoying extra clicks). Maybe secondary links, like blog, can go to some other place.

@skipjack
Copy link
Collaborator

skipjack commented Jan 5, 2017

@simon04 yea I'd definitely lean towards the second approach:

Another approach would be to list /concepts, /guides also in the submenu of /documentation. Whether we then keep their top menu entries is a matter of taste.

@bebraw as per your point:

Maybe secondary links, like blog, can go to some other place.

I've heard a few times now that the sidecar links are fairly undiscoverable and I'm starting to agree. Looking at some other docs sites like React, Babel and ESLint they all link to their blog and github pages in their top navigation. Regardless of this, even adding one more regular link to the nav will put us over the limit and likely cause UI issues with links overlapping the logo on smaller screens. We're bumping into the limit in the footer as well, and while maybe we should expand it to a larger height and different layout, those links are much less discoverable than the ones in the banner.

I can see this going either way right now, but I do think we're going to end up going back to a similar setup at some point.

@skipjack
Copy link
Collaborator

skipjack commented Jan 5, 2017

This required using both the menu (right-aligned) and the documentation submenu (left-aligned).

Also aligning the submenu to the right or parts of the main menu to the left doesn't look so bad:

image

@bebraw
Copy link
Contributor

bebraw commented Jan 5, 2017

It is good to note how ESLint tackles it. You can access the hierarchy from the front page without having to visit the pages themselves.

Based on that I would say if you could hover on top of documentation and see the submenu below it while you are on some other page, that would go a long way.

@skipjack
Copy link
Collaborator

skipjack commented Jan 5, 2017

@bebraw that's true, displaying the menu on hover could work.

@simon04
Copy link
Collaborator Author

simon04 commented Jan 16, 2017

What about (with improved spacing):

  • 2017-01-16-10-21-01-001
  • All docs are below Documentation
  • The sidecar is merged into the menu

@skipjack
Copy link
Collaborator

@simon04 yea something like that but without the multi-colored backgrounds and we'd probably leave the gitter link out and add some kind of fixed "Find Help" button or something for it instead. Personally, I'd prefer "Concepts", "Guides" and "Reference" (instead of Documentation) with the hover behavior @bebraw mentioned.

Either way though, I'm going to close this for now and open this discussion again in an issue soon. We're working abstracting the banner (and other stuff, see #301), so I'll make sure to keep all this stuff in mind (icons, hover, etc.) as I get react-banner ready for it's first working release.

If others bring up the navigation as a problem before then, then we can push one of the quick fixes we've discussed.

@skipjack skipjack closed this Jan 16, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants