RedHat-UX / red-hat-design-system

Red Hat's Design System
https://ux.redhat.com
MIT License
97 stars 19 forks source link

[docs] Categorization for components #1437

Open markcaron opened 9 months ago

markcaron commented 9 months ago

Add categorization for components, so we can provide some additional taxonomy to assist in wayfinding/search-ability. For example, RH Button could have a category of Actions or RH Listbox could have a category of Inputs. Likely there might only be only one category on any given item.

There are a few approaches we can take in the future:

  1. Grouping elements in the Side Nav by category
  2. Providing filtering on the All Elements page

Steps

Just an idea

Development-wise, this could...perhaps...be as simple as some YML frontmatter, like:

category: Actions
coreyvickery commented 7 months ago

@markcaron @marionnegp First pass at a taxonomy.


Documents

Audit doc

https://docs.google.com/document/d/1KRpttAqJFby9ATUCID6KDUQErxRRHXqvF7sZPqIY_o0/edit#heading=h.e4z1ynaja07k

Figma with updated side menus

https://www.figma.com/proto/qb5QSsuBVRcuqf7Q5Yj6Wy/Docs-overhaul---taxonomy-research?page-id=1%3A3&type=design&node-id=1-479&viewport=106%2C128%2C1&t=oalgJhvDex7SL8tw-1&scaling=min-zoom&mode=design


Working taxonomy

Actions (5)

Containment (or Containers?) (7)

Data visualization

Emphasis (not 100% married to this) (4)

Feedback (or Communication?) (4)

Layout and structure (could be one or the other) (3)

Media (3)

Navigation (11)

Overlays (3)

Selection and inputs (4)

Text (or Typography?)

coreyvickery commented 7 months ago

@markcaron @marionnegp How are we feeling about this so far?

marionnegp commented 7 months ago

@coreyvickery

coreyvickery commented 7 months ago

@markcaron What do you think about Marionne's edits?

coreyvickery commented 4 months ago

@marionnegp @markcaron Once rh-chip is approved, we should add this to ux dot.