search

stathissideris / dali

dali is a Clojure library for representing, exporting and manipulating the SVG graphics format.
291 stars 16 forks source link

Docs are impressive! #17

Open aviflax opened 4 years ago

aviflax commented 4 years ago

I’m just seeing this repo for the first time and I just wanted to compliment you on your documentation. It’s impressive. Well done!

fmjrey commented 4 years ago

Hey @aviflax, nice to see you here, I'm landing here in this repo as part of some investigation inspired by your great conj talk about diagrams as data. I did a lot of diagrams in my last job, but maintaining them and fiddling with all the idiosyncrasies of the diagramming tool (draw.io in my case) is a big job which not everyone takes to heart. I'm also of the opinion that this needs some automation of some sort. Creating diagrams from data is definitely a first outcome, and SVG is definitely the way to go especially for printing big poster diagrams :) I also think there are a lot more that can be done going forward, e.g. tech radar where you also specify life expectancy and adopt-deprecate attributes, data being passed around, scenario flows as overlays, etc.

@stathissideris kudos indeed for producing this library with such a great documentation, you definitely did not write this just for yourself, much appreciated. Are you still planning to work on it?

aviflax commented 4 years ago

@fmjrey thanks so much for the kind words! It’s great to hear that we’re thinking along similar lines. I agree that once a model exists as data, there’s all sorts of useful data to add to, or connect to, the model.

Also BTW about SVG, I recently added support to fc4 for outputting diagrams as SVG, but it’s a little broken at the moment — it writes the SVG to files with a .html extension; browsers can read and render this file but they’re not actually valid SVG documents in the XML sense, and GitHub won’t render them as images in its diffs. More details here: https://github.com/FundingCircle/fc4-framework/issues/222 . You can download a release that has this fixed already, now, and I should have that release available via Homebrew soon as well.

stathissideris commented 3 years ago

@aviflax wow, I never thanked you for your compliment! Thank you very much, I'm glad you're finding this useful :)

stathissideris commented 3 years ago

@fmjrey I'm planning to work on dali whenever I get the motivation for it. I know it doesn't sound like much of a promise, but this is the harsh truth of open source -- it's not easy to find the time/energy to return to it when you have a full time job!