refactor: migrate from MDX to CSF stories with autodocs

canonical / react-components

A set of components based on Vanilla Framework

https://canonical.github.io/react-components

92 stars 51 forks source link

refactor: migrate from MDX to CSF stories with autodocs #1010

Closed rsmelo92 closed 5 months ago

rsmelo92 commented 7 months ago

Done

This PR migrates Card component stories from MDX to CSF, if accepted I will do it with all remaining components

Created a CSF file for rendering stories of the card component
Allowed autodocs on it
Deleted MDX version of Card's stories

Screenshots

https://github.com/canonical/react-components/assets/16295402/9cb0dd0f-146d-47bf-b6c1-371fc0d37818

QA

QA steps

Run the project
Open Card stories
Check that the behaviors haven't changed
Open other stories
Check that they didn't break as well
Open the code
Check that there is less code, less cognitive overload and it has improved

Fixes

Fixes: #1001 .

webteam-app commented 7 months ago

Demo: https://react-components-1010.demos.haus/?path=/docs/card--docs

bartaz commented 7 months ago

Thanks for the PR, I kicked off CI and demo for it: https://react-components-1010.demos.haus/?path=/docs/card--docs

rsmelo92 commented 6 months ago

@bartaz @petermakowski I'm waiting for this PR to be merged to migrate all other components, or should I add them to this PR?

huwshimi commented 5 months ago

Is there anything I can do to help this PR along? I'd like to migrate a bunch of components to this repo, but hoping this lands before I add the docs.

rsmelo92 commented 5 months ago

@huwshimi from my side I think it's all ok, just waiting for the PR to be accepted (or not) 🙃

huwshimi commented 5 months ago

@bartaz @petermakowski do either of you want to do a final review or would you be happy for me to do it?

petermakowski commented 5 months ago

@bartaz @petermakowski do either of you want to do a final review or would you be happy for me to do it?

I'm happy for you to do it!

huwshimi commented 5 months ago

Thanks everyone!

github-actions[bot] commented 5 months ago

:tada: This PR is included in version 0.50.6 :tada:

The release is available on:

Your semantic-release bot :package::rocket: