Where I can find the documentation of this library?

[nitinjs]

Where I can find the documentation of this library?

[mrbean-bremen]

There is currently very little documentation for this project. It certainly makes sense to add more documentation, but this will take some time (and contributors). Anyone is welcome to contribute to the documentation!

Currently available documentation

• documentation in GitHub pages
• the source code documentation (obviously)
• some sample projects under Samples

Note:
Pull requests for code documentation, new sample code or new/improved documentation in GitHub pages are always welcome!

Missing documention

Usage documentation:

• tutorials

Project documentation:

• a style guide

The same here: any contribution is welcome!

[joreg]

also whoever wants to work on documentation, here is a great introduction on how to best do so: https://www.divio.com/blog/documentation/

[dsafa]

How about docfx for documentation? It can handle normal markdown pages as well as generated api documentation.

[tebjan]

can docfx be hosted on github?

[mrbean-bremen]

I had a quick glance, and noticed that the project has an example where it is integrated with AppVeyor and creates GitHub pages (via the gh-pages branch), so this should not be too complicated (hopefully). I have done something like this before, but with Travis.CI instead of AppVeyor, and for Python only (using Sphinx).
@dsafa - do you have experience with docfx?

[tebjan]

auto doc via gh-pages sounds great!

[dsafa]

@mrbean-bremen I've use it recently, it was easy to use although I did not do anything too complex.

[mrbean-bremen]

@dsafa - thanks! I think I will wait for the .Net Core merge, as that changes the AppVeyor config, and try to put something together afterwards. I may come back to you then...

[wieslawsoltes]

The documentation (at least Getting started and API) would be much appreciated.

I am currently exploring SVG library myself just debugging stuff by hand: https://github.com/wieslawsoltes/Draw2D/blob/SVG/src/SvgDemo/Program.cs

[mrbean-bremen]

I may have a go at the API stuff some time later, but my free time is limited, and I would appreciate any help...

[mrbean-bremen]

Getting Started and generated API pages are now existing, the documentation link is in the README, and specific documentation requests can be handled in separate issues - closing this one.