React-diagrams: More documentation?

Created on 12 Nov 2018 · 7Comments · Source: projectstorm/react-diagrams

Hi, love this project and it's going to be absolutely indispensable to me in creating one of my interfaces. I just wish there was stronger documentation behind creating custom nodes. Are there any plans on updating the docs site? I read on the react-canvas repo that you are quite busy and haven't been working on this... I'll do my best to contribute with my own work as well.

help wanted

Source

tangert

👍8 🚀1

All 7 comments

Also have to crack open the source to figure out how anything (outside of examples) works with this lib

I think the exercise of documenting may actually lead to improvements to the api interface where things are counter-intuitive.

Would also be willing to coordinate on a doc effort, perhaps TSDoc?

kmannislands on 13 Nov 2018

👍1

Yes, I can't personally commit to a rigid schedule with it or anything but we should totally work on improving the API. I think the main things I'd want to focus on are easily creating custom nodes and grouping them together, especially just by passing in standard React components. For now I will document as I prototype. The whole widget/model/factory API seems a bit cumbersome and not so sure why it's necessary-- gotta look into it more...

tangert on 13 Nov 2018

👍1

@kmannislands what do you want to focus on?

tangert on 13 Nov 2018

Hi, thanks for all your work on this really interesting API ! However, so you think it would be possible to prepare a documentation of the API, with the props of each important components ? The demos are quite useful to understand pretty well how it works, however it is hard to be really productive without this kind of documentation.