ipfs-inactive / docs

[ARCHIVED] 🤖 📚 IPFS documentation working group, plus IPFS docs site code
https://docs.ipfs.io/
Other
87 stars 62 forks source link

[DOCS ISSUE] sidebar menu item click-ed state behavior confusing #420

Closed momack2 closed 4 years ago

momack2 commented 4 years ago

I notice the first time I click on a sidebar title (ex "concept") it expands a list of sub menu items - however if I click away to "install" that submenu stays open and navigating back to "concept" actually collapses the submenu view. This is confusing behavior (would expect clicking away to install would also un-expand the sub menu by default, and re-clicking would re-expand) without some sort of expand/collapse affordance that I can see move between clicks that indicates the state of this submenu. Could we either add an affordance to show if submenu expanded/collapsed, or by default un-expand the menu when other menu item is clicked?

jessicaschilling commented 4 years ago

@cwaring, we'd discussed this in the past. Can you please investigate? Thank you!

cwaring commented 4 years ago

Agree to keep this on the todo list! This is mostly a problem because "Install IPFS" is currently not a group section like the other menu items, there are plans to change this in an upcoming content re-org so this may become a "Getting Started" section containing "Install IPFS", which would then make the navigation behave consistently.

Additionally I could apply a patch to disable the ability to collapse the menu if we don't wish to take advantage of this functionality in the future.

Let's discuss in the next design review to iron these quirks out :)

jessicaschilling commented 4 years ago

We could separate out the https://docs-beta.ipfs.io/install/ page into three separate pages in the interim, which is a little bit of overkill considering they don't each have a ton of content on them, but it would effectively fix the expand/collapse issue. I'd suggest leaving that top-level install page as it is, but blow out each of its sub-sections (dip your toes, host/share files on your own, host/share at scale, integrate into your app) into its own page, with additional content on them.

@johnnymatthews - what do you think? Are you amenable to writing some additional content foe each of those pages/do you have time right now?

johnnymatthews commented 4 years ago

Install IPFS is going to end up in a section called Getting Started, so it'll act exactly the same as the other group sections. Here's the revamped docs map as a refresher (will change over time).

Map Revamp

jessicaschilling commented 4 years ago

Good point -- and Getting Started content is a high-ish priority, correct? Closing this issue to keep things tidy. Thanks!

ericronne commented 4 years ago

@johnnymatthews before implementing, if we haven't already done so, it'd be wise to test the new structure with users to confirm that they can find what they need, that categories and labels make sense :bowtie:

you can use workflowy for lightweight IA tests on docs (even though that's not what it's designed to do), like we've done previously for the beta site … https://workflowy.com/s/ipfs-docs-eric/Z0bburAwrxtbpKTh

or something like treejack, which has the benefit of a fancy explainer video https://www.optimalworkshop.com/solutions/information_architecture

johnnymatthews commented 4 years ago

So I did build the site with the new sidebar mapping, but I foolishly cloned over it during the Christmas break. I'll throw it all together again over the weekend for testing again.

jessicaschilling commented 4 years ago

And we've already got a bunch of users you can test with from the beta testing Google form 😊

johnnymatthews commented 4 years ago

Didn't get a chance this weekend to build the side-nav, mainly due to the NFL playoffs. I've got a 2 hour train journey this evening though, so I'll be able to get it done then.