openui / open-ui

Maintain an open standard for UI and promote its adherence and adoption.
https://open-ui.org
Other
3.58k stars 191 forks source link

Navigation Architecture #285

Open una opened 3 years ago

una commented 3 years ago

Context: Outcome of initial iA workshop session

gregwhitworth commented 3 years ago

Also there were discussions around a different landing page for each component to quickly find relevant content and an overview of meta information about that component. @bkardell @melanierichards raised this. Additionally, this would surface how the expected structure of the navigation would occur.

melanierichards commented 3 years ago

A couple weeks ago, a small group brainstormed some approaches to the information architecture (IA). We thought about various jobs to be done, and what structure of IA might be needed to meet those various JTBD. The scratchpad document is here. Note, this doc is currently readonly. Members of that brainstorm, please comment here if I missed anything pertinent in this distillation or if any new ideas come to mind. :)

Summary of the brainstorm

Navigation

Distilling various ideas together, the IA ends up something like the following:

We weren't sure yet whether there should be a top-level nav item along the lines of "Component Library" or "Catalog". Here we are thinking about some way for an author to stop on the site and say, "ok, I don't really care about all the research and what stage a proposal is at for a given component. All I want to do here is consume the Open UI suite of Web Components in my project." We could elevate this to the top level, or one could get to the consumable WC from a work item's landing page. This could be deferred until it becomes more relevant, though?

"Home" page contents

Clearly address:

Get involved contents

Work Items contents (index)

Each work item's landing page

boazsender commented 3 years ago

I think this is great. I can take the action item to write the guidance and how to get started and follow the working mode (#197)

melanierichards commented 3 years ago

Group resolved to go forward with this plan, and we'll create separate issues for the work involved to implement.

bkardell commented 3 years ago

I really like these changes... until you really 'see it' and try to use it hard to imagine beyond this and I think this would be a quantum leap improvement, I agree we should make N issues out of this so people can bite off meaninful chunks and move us that way. might it be helpful if people from that session (sorry I missed it due to an emergency) gave a little thoughts/advice on whether there were any kind of order dependencies that would be helpful here so we aren't left in a weird state because some items are easier than others?

melanierichards commented 3 years ago

@bkardell I don't think there's too much interdependency, to be honest. Mostly:

melanierichards commented 3 years ago

Ok, just opened up a bunch of issues. Feel free to:

github-actions[bot] commented 2 years ago

There hasn't been any discussion on this issue for a while, so we're marking it as stale. If you choose to kick off the discussion again, we'll remove the 'stale' label.