Currently the only documentation comes in the readme. The projects needs some more.
@colin-young, do you have any suggestions with regard to human-facing documentation? In last project we created some documentation with mkdocs. It's simple enough written in markdown and has a familiar ReadTheDocs-like theme.
In JsonLd.Entities I went the path of code-as-docs. Each documentation is written in C# and converted into markdown. This way it's easier to keep it in sync with code and also doubles as automatic tests.
GitHub wiki would be ok but does it work in collaboration?
Thoughts?
Currently the only documentation comes in the readme. The projects needs some more.
@colin-young, do you have any suggestions with regard to human-facing documentation? In last project we created some documentation with mkdocs. It's simple enough written in markdown and has a familiar ReadTheDocs-like theme.
In JsonLd.Entities I went the path of code-as-docs. Each documentation is written in C# and converted into markdown. This way it's easier to keep it in sync with code and also doubles as automatic tests.
GitHub wiki would be ok but does it work in collaboration?
Thoughts?