Closed iantaylor-NOAA closed 3 months ago
I see a drawback of using the diagrams in github issues is that email notifications don't render the diagrams in the same way as they do on the github website.
@iantaylor-NOAA that's so cool that on GitHub they are automatically rendered and that you can preview them! The live editor was nice for collaborative editing without needing to switch back and forth between write and preview views on github
We can add detailed instructions in the collaborative book if R interface group find this diagram useful.
Because we are using .Rmd files in the workflow website, the mermaid graph does not render. See these lines. It needs to be wrapped in DiagrammeR::mermaid()
according to this stackoverflow chat. Fixed with e8ca014.
@iantaylor-NOAA can we close this issue given that there are no proposed diagrams to add at the moment?
@kellijohnson-NOAA, thanks for fixing the broken render and suggesting closing the issue. The goal of this issue was to raise awareness of the option to use mermaid and that has been achieved.
@MOshima-PIFSC, @k-doering-NOAA and I discussed mermaid diagrams in the context of a design document for FIMS output today.
Here's a potential flow for this work:
That diagram above was rendered automatically within this github issue from the code below (displayed below as code using 4 backticks--another useful thing I learned today)