cosmos icon indicating copy to clipboard operation
cosmos copied to clipboard

Docs: Dealing with sub-pages in the navigation

Open landitus opened this issue 6 years ago • 2 comments

Is your feature request related to a problem? Please describe. We currently have 2 ways of nesting sub-pages in the navigation: Some components have a 2nd level in the sidebar and some content pages don't, but have a accordion style internal navigation. I believe this pattern creates confusion and it's not easy to navigate.

screen shot 2018-12-10 at 17 29 34 screen shot 2018-12-10 at 17 29 45

Describe the solution you'd like We can easily improve this by having a single unified pattern that allows pages to have sub-pages (nesting), but also displays content in different subpages. Even if subpages will be short, they are a single topic and should be self-contained in their own page as they may grow in the future. If not, the content should be merged with another topic.

Also, having proper segments in the URL would be more beneficial as well:

http://url/#/contribution-guide#system-guidelines http://url/#/contribution-guide/system-guidelines

Example: subpages

We may do a more thorough design exploration for the docs in the future, but I think having the accordion in the sidebar is definitely more useful and worth doing.

landitus avatar Dec 10 '18 20:12 landitus

What do you think @siddharthkp ?

landitus avatar Dec 10 '18 20:12 landitus

I like it

siddharthkp avatar Dec 11 '18 05:12 siddharthkp