bpmn-visualization-examples icon indicating copy to clipboard operation
bpmn-visualization-examples copied to clipboard

[FEAT] Review explanations in the example README files

Open tbouffard opened this issue 4 years ago • 0 comments

Explanations are not minimal

We approximatively explain what is done in the example code and not what the minimal code should be. In example, we do more because of added user interactions.

For instance, in load-remote-bpmn-diagrams 0.6.0

  • too much elements related to the way we implement our example
  • not up-to-date with the current implementation

Compare with load-local-bpmn-diagrams 0.6.0 which is more focussed and don't duplicate what is available in the html/js file.

Tasks

  • [ ] Review all examples to have a README that give explanations and don't copy what is already in the html/js files
  • [ ] if needed, add comments in the html/js files to make things easier to understand, but don't do this in the README
  • [ ] Find a way to explain that the code in the README is minimal and that in the example implementation this is more complex because of user interactions, html integration, ...
  • [ ] Also adjust based on decisions taken for documentation and examples from the main repository (https://github.com/process-analytics/bpmn-visualization-js/issues/866): id of the html container displaying the BPMN Diagram. The example code should be updated as well

tbouffard avatar Nov 10 '20 12:11 tbouffard