[DOC] Generate HTML documentation

[tbouffard]

For a more user friendly documentation, we should provide HTML documentation and publish it (#19)

This could include

• shinny apps and showcase example from Rmd: [DOC] Explain how to include in Shiny apps or an RMarkdown file #22
• general documentation instruction: https://r-pkgs.org/man.html
• use vignettes to create articles/how-to guide: https://r-pkgs.org/vignettes.html
• see also https://www.rdocumentation.org/search?q=bpmn for publishing and nicer preview
• use https://pkgdown.r-lib.org/, see also [DOC] Host documentation on GitHub Pages #19 and [DOC] Deploy documentation preview on Surge #125

Also include the following feedback from #128

• ✔️ index page: readme of the repo cannot be used. It contains HTML code that is not correctly rendered and too much information. Create a README.Rmd like in https://github.com/r-lib/pkgdown/blob/main/README.Rmd?
• ✔️ package file:
  • review the file name and drop alias to use bpmnVisualization instead
  • some content is empty. See what we have in the RStudio preview and what CRAN generates as HTML page
  • do we really need the information it provides? if not, not need to implement [DOC] Generate the bpmnVisualization-package.Rmd with {roxygen2} #123

See also #30

Notes: next improvements will start with #161