Skip to content

Commit 033aeb1

Browse files
committed
Update the development documentation
1 parent 2d45453 commit 033aeb1

File tree

2 files changed

+14
-7
lines changed

2 files changed

+14
-7
lines changed

CONTRIBUTING.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,20 @@ git push --force-with-lease 25-customize_overlays
100100

101101
At this point, you're ready to make your changes! Feel free to ask for help. Everyone is a beginner at first :smile_cat:
102102

103-
## bpmn-visualization-js update
103+
## ⚒️ Development
104+
### Installation
105+
```r
106+
devtools::install()
107+
```
108+
109+
### Regenerate the R documentation
110+
The **R documentation** (.Rd) format is generated from the function comments thanks to [roxygen2](https://roxygen2.r-lib.org/). \
111+
To regenerate this documentation after function comment updating, run this command:
112+
```r
113+
devtools::document()
114+
```
115+
116+
### bpmn-visualization-js update
104117

105118
- Change [bpmn-visualization.min.js](inst/htmlwidgets/lib/bpmn-visualization/bpmn-visualization.min.js). The file can be retrieved from [jsdelivr](https://www.jsdelivr.com/package/npm/bpmn-visualization) or [unpkg](https://unpkg.com/browse/bpmn-visualization/).
106119
- Update the version of `bpmn-visualization` in [bpmnVisualization.yaml](inst/htmlwidgets/bpmnVisualization.yaml)

README.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -124,12 +124,6 @@ You can find more detail in our [Contributing guide](CONTRIBUTING.md). Participa
124124

125125
✨ A BIG thanks to all our contributors 🙂
126126

127-
## ⚒️ Development
128-
### Installation
129-
```r
130-
devtools::install()
131-
```
132-
133127
## 📃 License
134128

135129
`bpmn-visualization-R` is released under the [Apache 2.0](LICENSE) license. \

0 commit comments

Comments
 (0)