Provide Documentation

[ricardomatias]

Adding a (self) hosted solution with up to date documentation.

ReadMe.io could be a great option since it's a well built, easy to use system and free for open source.

---

Helpful resources, despite the lack of documentation:

• diagram-js example
• bpmn-js architecture walkthrough, covering many facets of diagram-js and how it builds the foundation of our tools
• source code, including comprehensive
  code docs

[matehat]

👍 so badly

[ricardomatias]

What kind of documentation are you looking for @matehat ?
Your feedback would help us tackle this issue.

[matehat]

Just for a bit of background, I'm incorporating BPMN.js, thus diagram.js in a web app for a project where we need to design these sort of execution flows. In addition to just the graphical modeling itself, we have additional information alongside the business logic data. Things like exactly what gets executed in a task, and some contextual data.

So getting the modeler to work was pretty straightforward thanks to your examples. But getting richer interactions with the rest of our app was non trivial. I got to figure out by browsing the code, that you're using a dependency injection pattern, much like angular, that I need to get a handle on the eventBus object to hook into certain events. But again, figuring out which event I should hook onto for when an element gets selected for example, and what data will be available to me, is a matter of browsing the code and trying out things by hand in the developer console. So the process of learning how to leverage these two libraries in a more complex manner is really slow and painful, but doable.

Another example, I have no idea how I can change the label of a object that's already in the diagram, or how I can add a condition expression to a sequence flow. I will probably figure out, but it's slow and painful.

Unless I'm missing something of course 😃

BTW awesome work guys, despite the documentation thing, the project is incredibly well made.

I would however suggest adding something in there to customize all the defaults that are used throughout, like element sizes, zoom caps, and so on.

[matehat]

To be more precise

• maybe a list of all events (and/or commands that get executed through the command stack) that can be triggered, and what data lives in it.
• the objects that are available by dependency injection, and what we can do with them (their methods). That would include a comprehensive description of the arguments.
• And maybe examples for when you want to register new services, interceptors, command handlers and all sort objects that need to implement a certain interface to be used for certain roles.

[nikku]

Thanks for your comprehensive feedback @matehat. We will try to address these issues in the next milestones.