Open YairHalberstadt opened 4 years ago
@YairHalberstadt Hi. Here is how I am addressing it. My "lazy" goal was also to keep the docs together with code to simplify the dev and contribution, plus I want my docs and samples to be always runnable and up-to-date.
The tool (readme has the references to the full blown docs in my project):
https://github.com/dadhi/CsToMd#overview
Part of the docs contrib guide:
https://github.com/dadhi/DryIoc/blob/master/CONTRIBUTING.md#contributing-to-the-documentation
Thanks will check it out!
So I've created the wiki just to get us started. For now it doesn't contain any samples, and so I'm not using CsToMd. I hope to set that up pretty soon, with a github action that generates the markdown from a project, and puts it in the docs folder.
For now, any files added to the docs folder, will be copied over into the wiki via a github action. It doesn't delete anything in the wiki, so that needs to be done manually.
If I find this process too limiting I will probably set up github pages instead at some point.
The ReadMe is getting longer and longer. We should create a proper wiki/static website for documentation. This will be an appropriate place for other things like examples as well.
The documentation must be kept in source control in this repository. If we use github wiki we should use a github action to copy documentation to the wiki repository.