19 lines
850 B
Markdown
19 lines
850 B
Markdown
# Diagrams
|
||
|
||
The SVG diagrams in `docs/` for the README, talks and posts, each in a light and a dark variant.
|
||
|
||
| Diagram | Source |
|
||
|---|---|
|
||
| `werkrevisor-pr-workflow*.svg`: how a pull request gets merged | drawn by hand |
|
||
| `werkrevisor-review-inside*.svg`: configuration, steps and services of one review | `review_inside.py` |
|
||
| `werkrevisor-review-decisions*.svg`: where a review ends early or takes a shortcut | `review_decisions.py` |
|
||
|
||
Run a generator from the repository root, e.g. `python3 tools/diagrams/review_decisions.py`; it writes both variants to `docs/`.
|
||
For a PNG of 2400 × 1350 pixels:
|
||
|
||
```sh
|
||
inkscape docs/werkrevisor-review-decisions.svg --export-type=png --export-width=2400 --export-filename=decisions.png
|
||
```
|
||
|
||
When the review changes, update the steps or decisions in the generator and the hand-drawn diagram in the same PR.
|