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

Curate User Guide menubar: drop icons and GH entry #942

Closed
chalin opened this issue Mar 21, 2022 · 2 comments · Fixed by #945
Closed

Curate User Guide menubar: drop icons and GH entry #942

chalin opened this issue Mar 21, 2022 · 2 comments · Fixed by #945

Comments

@chalin
Copy link
Collaborator

chalin commented Mar 21, 2022

From a view with a medium width, this is what the menubar can look like:

image

It is way too busy IMHO and the wrapping of menu titles (especially since they have icons), looks bad.

Given that we'll be adding a blog soon (#935), I'd propose that free up some menubar real estate by doing the following:

  • Drop the GitHub menu. This is redundant since the same link is in the footer.
  • Drop the menu icons.
  • Give the Documentation entry a linkTitle of Docs
  • Maybe give the Example Site entry a linkTitle of Example

Comments @LisaFC @emckean @geriom @deining?

@LisaFC
Copy link
Collaborator

LisaFC commented Mar 25, 2022

The icons are optional so we can easily remove them (once we make sure that the docs still let users know they exist if they want to enable them for their own sites), I agree it looks very busy with everything enabled.

My only concern about removing the Github link "because it's in the footer" is that a lot of readers don't get as far as seeing the footer, especially with long pages. Though looking at other sites (eg K8s and gRPC) they don't all have a GitHub link in the header so we could probably lose it.

I'm reluctant to shorten the linkTitles just for smaller screens - in particular I think we should be clear that this is a special Example Site rather than, eg, a link to our Examples page.

@chalin
Copy link
Collaborator Author

chalin commented Mar 27, 2022

The icons are optional so we can easily remove them (once we make sure that the docs still let users know they exist

Yes, it's in the docs -- see Adding icons to the top-level menu.

looking at other sites (eg K8s and gRPC) they don't all have a GitHub link in the header so we could probably lose it.

👍

I'm reluctant to shorten the linkTitles

Ok, I'll wait for that.

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 a pull request may close this issue.

2 participants