emulsify-ds / compound

Compound is the default component collection for Emulsify
https://emulsify-ds.github.io/compound/
GNU General Public License v2.0
13 stars 11 forks source link

Update colors.mdx #15

Closed Mihaic100 closed 2 years ago

Mihaic100 commented 2 years ago

Hi nice work on this demo branch, lets fix this deprecation block scoped blocks import according with:
https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#deprecated-scoped-blocks-imports

and canvas: https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#previewprops-renamed

thanks

Summary

This PR fixes/implements the following bugs/features

Explain the motivation for making this change. What existing problem does the pull request solve?

Documentation Update (required)

If this pull request requires a change to Emulsify documentation, those changes, updates, and/or new information must accompany this pull request.

How to review this PR

Closing issues

Closes #

ModulesUnraveled commented 2 years ago

Hey @Mihaic100, thanks for the PR!

I was actually considering removing the docs feature from our base install since the only file that uses it is a "hey, you could put docs here if you wanted" file, but not actually being used.

Before I do that though, I was curious how extensively you've used it, and whether it's something we actually want to support by default, or not.

Can you share a Storybook instance where you've implemented docs?

Mihaic100 commented 2 years ago

Hi @ModulesUnraveled I don't have a good example yet, but working on it. One thing that I want to experiment is to display maybe twig code and html like paternlab does for components. Also I like when you use the docs feature that you can see all the components in a single place like a list.

Anyway, i think is good to have the feature documented if you plan on removing the add-on, at least people know it is possible to add and use the plugin.

One other suggestion that I have is maybe considering adding the LTR plugin in order to test left to right: https://storybook.js.org/addons/@pxblue/storybook-rtl-addon

Thanks Mihai

ModulesUnraveled commented 2 years ago

@Mihaic100 I'd love to see your example of how you're using the docs addon if/when you get something up in a public place!

Since we don't actually use the docs addon at this time, I'm going to remove it from this repo. If we want to add it later, we can always do that, but this repo shouldn't have extra stuff in it that's not actually being used/demonstrated.

Along those lines, the RTL plugin looks like it provides some great value! But since we don't have anything in here to demo it, we'll leave it out.

None of that should dissuade you from using one or both of them in your projects! (As well as any of the other fantastic Storybook addons). This repo is intended to be "boiler plate code" that anyone can use as a starting place, so we don't want to have too much in here that we'd just have to strip back out after an initial install. (That's also why the components are so sparsely styled)

Thanks for your contributions, I can't wait to see where else you choose to help out!