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

Proposal for Forma36's website navigation #455

Closed
gui-santos opened this issue Apr 6, 2020 · 4 comments · Fixed by #456
Closed

Proposal for Forma36's website navigation #455

gui-santos opened this issue Apr 6, 2020 · 4 comments · Fixed by #456
Labels

Comments

@gui-santos
Copy link
Contributor

Hey!

While working on the documentation search last Friday, I played around the navigation to try to improve it a little bit.

The issues I was trying to solve is while scrolling down to read some documentation if you want to go to another page you would need to scroll back up to find the navigation again.
The same thing happens if you want to search for something or click on a social link (Blog, GitHub and Community).

I took inspiration in how other documentation websites deal with this, like:

And I propose moving all the navigation to the side menu. Keeping the logo, the social links and the search fixed in the top left. The list of links for the components documentation would scroll independently from the content (see the gif). Also, we can keep the three categories (Foundation, Guidelines and Components) always expanded.

Home

Screenshot 2020-04-06 at 13 05 50

Documentation Page

Screenshot 2020-04-06 at 13 06 09

Scrolling

Apr-03-2020 19-25-51

@mshaaban0
Copy link
Collaborator

Yo, I love this, please do it 🥺

@m10l
Copy link
Contributor

m10l commented Apr 6, 2020

Having the sidebar stay in position and giving it it's own scrollbar is a good improvement, but I'm not keen on moving the other elements into the sidebar. The idea behind things at the moment is that the side navigation is for documentation, and the items in the header are for external links.

@gui-santos
Copy link
Contributor Author

@m10l TBH I don't have a strong argument for moving the external links to the side hahaha. I would say we can keep the topbar and give the sidebar its own scroll like in this docs:
https://tailwindcss.com/docs/installation

And it would work great... what do you think?

@m10l
Copy link
Contributor

m10l commented Apr 7, 2020

@m10l TBH I don't have a strong argument for moving the external links to the side hahaha. I would say we can keep the topbar and give the sidebar its own scroll like in this docs:
https://tailwindcss.com/docs/installation

And it would work great... what do you think?

I think that'd be great!

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

3 participants