Documentation For Diagram JS

[Priya-Ahuja]

Is your feature request related to a problem? Please describe.

A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

Describe the solution you'd like

A clear and concise description of what you want to happen.

Describe alternatives you've considered

A clear and concise description of any alternative solutions or features you've considered.

Additional context

Add any other context or screenshots about the feature request here.

[nikku]

Please edit your issue, use the issue template provided and add the relevant context / description for your issue. We'll otherwise need to close this issue as invalid,

[Priya-Ahuja]

@nikku Apologies for incomplete information , however can you please guide me to a proper documentation of Diagram JS as Read me doesn't seem to help a lot in my case. I have to know about how all the modules (specially in lib) are working.

[pinussilvestrus]

Hi @Priya-Ahuja
So if I understand you correctly you're just looking for a documentation? You can find an overall explanation here.

At the moment there is no standalone documentation for diagram.js. Also see this issue. Maybe the example app can help to understand how things are working. We also always try to document our code, so one can understand the library when using it.

However the previous title of this topic makes me thinking that you had a problem. Maybe you can give us more details in the form @nikku mentioned it. If you've opened this issue just for getting to know a general documentation, we will close it since there is no real issue or feature request.

[nikku]

I have to know about how all the modules (specially in lib) are working.

Consider looking into our comprehensive test suite if you'd like to understand the detailed functioning of the library. For a high level overview how diagram-js helps you build editors I recommend reading through the bpmn-js architecture walkthrough, too.

[nikku]

Closed as a duplicate of #78.