search

projectstorm / react-diagrams

a super simple, no-nonsense diagramming library written in react that just works
https://projectstorm.cloud/react-diagrams
MIT License
8.65k stars 1.17k forks source link

Where is the documentation? #848

Open Akhi1 opened 3 years ago

Akhi1 commented 3 years ago

Hi there, I want to use react-diagrams library for my project requirement and I'm looking for documentation or few demo projects etc. Unfortunately, the links provided here are either dead or with partial data. Please help me find the proper documentation for me to start with apart from the MD files available here within the project.

If I remember correctly, code was generated in the right panel of this website http://projectstorm.cloud/react-diagrams/ but now I can't find that either.

Expecting help as soon as possible. Thank you.

kobajs commented 3 years ago

Hey @Akhi1 , the sad thing is that the documentation is poor. Also storybook gives some notion about capabilities and limitations, but as you said, seems to be broken. Today I was trying to see some things at event listeners.

I've been following the development of this repo since last year. I saw a great change recently that separates diagram gallery from the monorepo packages and I'm pretty sure that this causes the issue. Also, even the development section for contributors seems to be broken (I've tried to run this morning).

What I can say is that the best you can do is try to dive deep and play a bit with the project to have a good insight about that

rob-myers commented 3 years ago

I'm also surprised by the lack of documentation, given how impressive this project seems to be.

But it is at least possible to:

  1. Step through the example project.
  2. Step through the code for each story.
  3. Figure out the API using intellisense.