search

dagrejs / dagre-d3

A D3-based renderer for Dagre
MIT License
2.83k stars 588 forks source link

Is there any documentation #379

Open rookieLink opened 4 years ago

rookieLink commented 4 years ago

I want some document about dagre-d3, is there any documention that it can show me how to use and what the method to do ?

ryw commented 4 years ago

Docs are here https://github.com/dagrejs/dagre-d3/wiki

johanwasserman commented 3 years ago

Docs @ https://github.com/dagrejs/dagre-d3/wiki are seriously lacking looking at the source and capabilities.

The difference between a so-so tool and a GREAT tool is documentation. Would be great to have a full API doc to work with instead of spending hours scanning source code for what the tool can and can't do.

rookieLink commented 3 years ago

@johanwasserman Yes, this is what I want to say. We need a good document to help us understand and use, instead of spending a lot of time to scan source

corwin-of-amber commented 3 years ago

There are many options on graph, node, and edge elements. I find them anecdotally in scattered examples across the Web. It would be sooo good to have a comprehensive list.

gordonwoodhull commented 3 years ago

I think at this point it would have to be a community effort, since the original author left some time ago.