frequency-chain / style-guide

A style guide to be used for consistent Frequency branding.
https://frequency-chain.github.io/style-guide/
Apache License 2.0
0 stars 0 forks source link

Create style guide basics #2

Closed claireolmstead closed 4 weeks ago

claireolmstead commented 1 month ago

Goal

The goal of this PR is to create a package we can release to setup the basics of our style guide.

Closes #1

Discussion

Currently the components are loading into /src in the package, so you have to reference that path when importing a component. Is there a way to avoid that?

Checklist

How To Test the Changes

  1. Create package
  2. Install package
  3. Use package
JoeCap08055 commented 1 month ago

Great work!

Am I right in assuming that a consumer of the package would not be interested in the Storybook UI (that's more for exploring the styles in this repo)? And that the consumer is really mostly interested in the base component/color/font definitions? If that's true, it might be best to separate that out into separate packages, so that the published package only contains the core components and not the Storybook UI. Take a look at the SIWF repository; that's also a Vite/Svelte project with separate packages; some of which are published & some that aren't.

If that's the route we think we want to go, I'd be okay with merging this & make that the subject of a subsequent issue/PR.

JoeCap08055 commented 4 weeks ago

Great work!

Am I right in assuming that a consumer of the package would not be interested in the Storybook UI (that's more for exploring the styles in this repo)? And that the consumer is really mostly interested in the base component/color/font definitions? If that's true, it might be best to separate that out into separate packages, so that the published package only contains the core components and not the Storybook UI. Take a look at the SIWF repository; that's also a Vite/Svelte project with separate packages; some of which are published & some that aren't.

If that's the route we think we want to go, I'd be okay with merging this & make that the subject of a subsequent issue/PR.

Linked to #13