sigma.js icon indicating copy to clipboard operation
sigma.js copied to clipboard

Published 20 hours ago • verified publisher icon jacomyal

Are there docs for sigma.js?

Open TGOlson opened this issue 2 years ago • 3 comments

Scanning the website and github, all I see are examples. But it's kind of hard to know where to start from just examples, are there any pages that document available methods to call, interactions w/ graphology, etc?

TGOlson avatar Nov 18 '22 20:11 TGOlson

Yeah, me too. I feel so bad that there are no API docs for this 10k stars library. It's confusing me.

youyinnn avatar Jan 17 '23 15:01 youyinnn

By the way, this library is super powerful and thanks to everyone for all the hard work! I've just found it to be slightly confusing digging around examples and code to wire things together, instead of docs. Thanks : )

TGOlson avatar Jan 21 '23 00:01 TGOlson

For the record, we have difficulties shipping that damn v3.0.0 version, but it will come with TSDoc and a Docusaurus-built documentation website (it's already done, we just need to fix some other things before releasing v3).

jacomyal avatar Feb 03 '24 13:02 jacomyal

The documentation is out! I just updated the website to the new v3 version, and the documentation is available here: https://www.sigmajs.org/docs/

Don't hesitate to report issues or the ask for new pages. Now that it's out, it'll be way easier to improve it and add new topics.

jacomyal avatar Mar 22 '24 10:03 jacomyal