GetJobber / atlantis

🔱 Atlantis
https://atlantis.getjobber.com
MIT License
27 stars 30 forks source link

docs(components): better disambiguate InlineLabel and StatusLabel [JOB-108048] #2092

Closed chris-at-jobber closed 3 weeks ago

chris-at-jobber commented 3 weeks ago

Motivations

When we did Summit the design team landed on a path where there would be no more InlineLabel, only the re-designed StatusLabel. Accordingly, we deprecated the component in the design system.

Over time, though, designers kept using InlineLabel and had some pretty legitimate use cases for not using StatusLabel. We’ve even aligned internally on usage guidance/disambiguation, so this adds that guidance to help designers choose the "right" *Label and removes references that suggest the InlineLabel should go away.

Changes

Added

Removed

Testing

Read the docs!

Changes can be tested via Pre-release


In Atlantis we use Github's built in pull request reviews.

Random photo of Atlantis

cloudflare-workers-and-pages[bot] commented 3 weeks ago

Deploying atlantis with  Cloudflare Pages  Cloudflare Pages

Latest commit: deb36b3
Status: ✅  Deploy successful!
Preview URL: https://708bdf99.atlantis.pages.dev
Branch Preview URL: https://add-better-inlinelabel-statu.atlantis.pages.dev

View logs

chris-at-jobber commented 3 weeks ago

Note: I can't actually get the InlineLabel docs page to render locally or on CF: image

chris-at-jobber commented 3 weeks ago

Confirmed the rendering issue was with trying to display a % character in the MDX. To resolve, I've removed the "%" from the "Trends" example in this commit image

MichaelParadis commented 3 weeks ago

Confirmed the rendering issue was with trying to display a % character in the MDX. To resolve, I've removed the "%" from the "Trends" example in this commit image

This looks to be a known issue that won't be fixed because Storybook 8 drops support for mdx https://github.com/storybookjs/storybook/issues/21802