search

lorenzwalthert / touchstone

Smart benchmarking of pull requests with statistical confidence
https://lorenzwalthert.github.io/touchstone
Other
54 stars 8 forks source link

Workflow documentation #79

Closed lorenzwalthert closed 2 years ago

lorenzwalthert commented 2 years ago

@assignUser what do you think of this (detail suggestions also welcome)? I think we could create a vignette and add some paragraph.

Screenshot 2021-11-20 at 12 18 09

As pdf: workflow-visualization.pdf

assignUser commented 2 years ago

Oh nice, I like the idea and overall look! I think it is visually unbalanced with the "manual" side lacking any kind of frame compared to the gha side. Maybe a frame with R-Terminal on it or something like that would balance it out?

I think the grey for the yaml file frames and text is a bit to light and due to that to hard to read. A darker grey or the Github-purple (#6e5494) (and then an R blue for the terminal frame?) might read better?

And finally you are missing a word here:

All that run_script does except ...

lorenzwalthert commented 2 years ago

Thanks for the feedback I will adapt. I’ll also add more on asset pinning.