Skip to content

Commit f5353db

Browse files
authored
Merge pull request #152 from nanxstats/mermaid-docs
Improve workflow diagrams in docs with color palette
2 parents 4778922 + aa6511e commit f5353db

1 file changed

Lines changed: 26 additions & 1 deletion

File tree

docs/design/workflow.md

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,17 @@ flowchart LR
2626
Clone --> Next([To Phase 2])
2727
UseLocal --> Next
2828
Extract --> Next
29+
30+
style Start fill:#f4cccc
31+
style Next fill:#f4cccc
32+
style Setup fill:#fce5cd
33+
style CheckR fill:#fce5cd
34+
style InstallR fill:#d9ead3
35+
style InstallDocs fill:#d9ead3
36+
style PrepRepo fill:#fce5cd
37+
style Clone fill:#fff2cc
38+
style UseLocal fill:#fff2cc
39+
style Extract fill:#fff2cc
2940
```
3041

3142
This is implemented in `src/lib.rs` by orchestrating:
@@ -46,7 +57,21 @@ flowchart LR
4657
4758
RunCheck --> Output1[revdep/library/]
4859
RunCheck --> Output2[00check_diffs.md<br/>00check_diffs.html]
49-
RunCheck --> Output3[*.Rcheck/<br/>*.Rcheck2/]
60+
RunCheck --> Output3[\*.Rcheck/<br/>\*.Rcheck2//]
61+
62+
Output1 --> End([Complete])
63+
Output2 --> End
64+
Output3 --> End
65+
66+
style Start fill:#f4cccc
67+
style End fill:#f4cccc
68+
style ResolveSys fill:#fce5cd
69+
style InstallSys fill:#d9ead3
70+
style PreInstall fill:#fce5cd
71+
style RunCheck fill:#c9daf8
72+
style Output1 fill:#fff2cc
73+
style Output2 fill:#fff2cc
74+
style Output3 fill:#fff2cc
5075
```
5176

5277
The two key pieces are:

0 commit comments

Comments
 (0)