documentation.md

Writing and updating documentation

• Updating workflow images

---

Updating workflow images

Workflow images in docs/images/ are written in the open source dot language from GraphViz. For an overview, see Drawing graphs with dot.

If you update the .dot files, you should also update the corresponding .svg images. GraphViz includes a command-line tool, dot, for converting dot files into image in various formats.

To convert a .dot file to an .svg file:

$ dot -Tsvg workflow.dot > workflow.svg

Alternatively, to convert all .dot files in docs/images/, use the Makefile:

$ make clean svgs

Alternatively, use an Editor supporting live preview of GraphViz images that also allows these to be exported as .svg images.