Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOC] Create a vignette showing how to generate the image of the README #157

Open
tbouffard opened this issue Nov 24, 2022 · 0 comments
Open
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@tbouffard
Copy link
Member

tbouffard commented Nov 24, 2022

The image shows an example of a BPMN diagrams explaining a functional scenario (Email Voting) and involves a lot of overlays (both on shapes and edges). It will be also easier to know how we generated the image: currently, we have to remember how to generate it.

The R script used to generate the image is described in #45 and #72. It must be fixed for #84
Vignette documentation: https://r-pkgs.org/vignettes.html

Resources about vignettes

examples from the ggfun package

@tbouffard tbouffard added the documentation Improvements or additions to documentation label Nov 24, 2022
@tbouffard tbouffard added this to the 0.2.x milestone Nov 24, 2022
@tbouffard tbouffard changed the title [DOC] Add an article showing how to generate the image shown in the README [DOC] Add an article showing how to generate the image of the README Dec 29, 2022
@tbouffard tbouffard changed the title [DOC] Add an article showing how to generate the image of the README [DOC] Create a vignette showing how to generate the image of the README Jan 6, 2023
@csouchet csouchet modified the milestones: 0.3.0, 0.3.1 Jan 9, 2023
@tbouffard tbouffard modified the milestones: 0.3.1, 0.3.2 Jan 30, 2023
@tbouffard tbouffard modified the milestones: 0.4.1, 0.5.0 Apr 3, 2023
@tbouffard tbouffard modified the milestones: 0.5.0, 0.6.0 Sep 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants