Document the code 😅

[siddharthkp]

@pasupuletics Can you help document the code

I want to extend parts of it, but I don't really understand most of it

[sevketufuk]

And I dont understand how to use this library. In documentation you've created 'usage' part, it is not clear where to place that piece of code. Can you please explain it?
Thanks.

[pasupuletics]

Hi @sevketufuk , Configuration is as simple as using custom handlers in react-styleguidist. Here is the docs for how to use custom handlers in react-styleguidist docs

[pasupuletics]

@siddharthkp , I believe most of the code was documented and self explanatory. if you still want me any help, kindly share parts of code which you want to understand.

[fiennyangeln]

Hi @pasupuletics do you know how to integrate this with docz?

[siddharthkp]

Not sure if docz let's you hook on to the react-docgen parser (https://www.docz.site/documentation/creating-plugins)

maybe @pedronauck can help

[pasupuletics]

@fiennyangeln is docz relay on react-docgen? if yes, absolutely we can use this. can you please point me that, what sort of problem you are trying to solve?

[AlanaFarkas]

And I dont understand how to use this library. In documentation you've created 'usage' part, it is not clear where to place that piece of code. Can you please explain it?
Thanks.

Has anyone figured out where we should put the code given to us in the 'usage' section?

[siddharthkp]

@AlanaFarkas might be useful to link to handlers in the docs for react-styleguidist along with the usage (https://react-styleguidist.js.org/docs/configuration/#handlers)

I don't think it's a well known feature so it can come as a surprise when usage says put it in handlers in config 😅

[AlanaFarkas]

Thanks for the reply @siddharthkp but I'm not using react-styleguidist. I'm using storybook.

[siddharthkp]

oh sorry, completed missed that.

I haven't used it in a long while now, but my guess would be to start with the babel plugin for react-docgen and add this package as a handler: https://github.com/storybookjs/babel-plugin-react-docgen

Would you be interested in testing this approach and adding it to the docs?