Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Where I can find the documentation of this library? #401

Closed
nitinjs opened this issue Jan 10, 2019 · 11 comments
Closed

Where I can find the documentation of this library? #401

nitinjs opened this issue Jan 10, 2019 · 11 comments

Comments

@nitinjs
Copy link

nitinjs commented Jan 10, 2019

Where I can find the documentation of this library?

@mrbean-bremen
Copy link
Member

mrbean-bremen commented Jan 10, 2019

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
Copy link
Contributor

joreg commented Jan 10, 2019

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

@mrbean-bremen mrbean-bremen pinned this issue Jan 17, 2019
@dsafa
Copy link

dsafa commented Mar 1, 2019

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

@tebjan
Copy link
Contributor

tebjan commented Mar 1, 2019

can docfx be hosted on github?

@mrbean-bremen
Copy link
Member

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
Copy link
Contributor

tebjan commented Mar 1, 2019

auto doc via gh-pages sounds great!

@dsafa
Copy link

dsafa commented Mar 1, 2019

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

@mrbean-bremen
Copy link
Member

@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
Copy link
Contributor

wieslawsoltes commented Jul 22, 2019

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
Copy link
Member

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
Copy link
Member

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.

@mrbean-bremen mrbean-bremen unpinned this issue Oct 17, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

6 participants