feat: Automatic docs from UI #1070
Conversation
tlgimenes
added
documentation
|
✔️ Deploy Preview for faststoreui ready! 🔨 Explore the source changes: f44a2d4 🔍 Inspect the deploy log: https://app.netlify.com/sites/faststoreui/deploys/61b381bc2d16bd00083467a3 😎 Browse the preview: https://deploy-preview-1070--faststoreui.netlify.app |
|
✔️ Deploy Preview for faststore ready! 🔨 Explore the source changes: f44a2d4 🔍 Inspect the deploy log: https://app.netlify.com/sites/faststore/deploys/61b381bca5a0cf00073a09ae 😎 Browse the preview: https://deploy-preview-1070--faststore.netlify.app |
|
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. Latest deployment of this branch, based on commit f44a2d4:
|
There was a problem hiding this comment.
🎉🎉🎉
Não pegou as props do componente List. Outra coisa é que o campo "Possible values" tbm não foi, tipo aqui: https://faststore.dev/reference/ui/atoms/Input#:~:text=Possible%20values,success%20%7C%20error
What's the purpose of this pull request?
This PR uses docusaurus-plugin-react-docgen-typescript to automatically generate documentation after the component's props definitions at faststore UI
How it works?
This is analogous to how storybook works. Just comment and add props to your React component at
@faststore/uiand use thePropsSectioncomponent to render these props in your markdown. Simple as that.Since
PropsSectioncomponent is defined in our own code, we can define the style we want, i.e. a table or list.How to test it?
Open any component at UI's reference and check the props