search

KeRNeLith / QuikGraph

Generic Graph Data Structures and Algorithms for .NET
https://kernelith.github.io/QuikGraph/
Microsoft Public License
471 stars 67 forks source link

Lack of documentation #7

Closed DanCRichards closed 4 years ago

DanCRichards commented 4 years ago

There is a lack of documentation of this project, I have been trying to use the original QuickGraph documentation however there seems to be discrepancies.

Can you please create some documentation?

KeRNeLith commented 4 years ago

Hello,

I think you already had a look at this documentation. It is generated from library code. While writing this I saw that the generated part is missing :s

BTW even if the generated doc is put back online, it can indeed be improved by adding custom articles. A wiki can also be a great enhancement to the project.

Do you have any more precise needs at the moment?

KeRNeLith commented 4 years ago

I made a fix for the automatic generated documentation (b207f337c8f9d26a276982b9e47a75bd157ae4c2).

KeRNeLith commented 4 years ago

I collected information from original QuickGraph documentation, and forked wiki to create the wiki dedicated to QuikGraph.

All pages in the wiki should contain example that are verified to work with this library. I personally read and fixed content and examples.

Here is the wiki.

Feel free to ask for more help or contribute to improve it :-)

Closing the issue for now.