jpmorganchase / salt-ds

React UI components built with a focus on accessibility, customisation and ease-of-use
https://www.saltdesignsystem.com
Apache License 2.0
109 stars 78 forks source link

The annotations on our diagrams are inconsistent. #3362

Open joshwooding opened 2 months ago

joshwooding commented 2 months ago

Package name(s)

Website / Documentation

Package version(s)

No response

Description

Some annotations include colons after a type e.g. Component: some don't

image https://www.saltdesignsystem.com/salt/patterns/app-header#desktop-layout

vs

image https://www.saltdesignsystem.com/salt/patterns/button-bar#layout

Some stack layout annotations, call them a component other's don't

image https://www.saltdesignsystem.com/salt/patterns/button-bar#layout

vs

image https://www.saltdesignsystem.com/salt/patterns/selectable-card#card-layout

same type labels are label small, other's aren't.

image https://www.saltdesignsystem.com/salt/patterns/app-header#desktop-layout

vs

image https://www.saltdesignsystem.com/salt/patterns/button-bar#layout

Steps to reproduce

No response

Expected behavior

No response

Operating system

Browser

Are you a JPMorgan Chase & Co. employee?

yunjungyeh commented 4 weeks ago

Work with @ivan-calderon

yunjungyeh commented 4 weeks ago

The current update helps new pattern pages be consistent. The images in the existing pattern pages would need to be updated when the time is right (e.g. update all images when Salt 2 is stable?) cc @joshwooding @ivan-calderon @bhoppers2008

joshwooding commented 4 weeks ago

The current update helps new pattern pages be consistent.

The images in the existing pattern pages would need to be updated when the time is right (e.g. update all images when Salt 2 is stable?) cc @joshwooding @ivan-calderon @bhoppers2008

Yeah, we can fix the other images when we do the image updates for the new theme work.