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

Create Wiki #54

Open
YairHalberstadt opened this issue Aug 31, 2020 · 3 comments
Open

Create Wiki #54

YairHalberstadt opened this issue Aug 31, 2020 · 3 comments
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed
Milestone

Comments

@YairHalberstadt
Copy link
Owner

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.

@YairHalberstadt YairHalberstadt added documentation Improvements or additions to documentation help wanted Extra attention is needed labels Aug 31, 2020
@dadhi
Copy link

dadhi commented Sep 8, 2020

@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

@YairHalberstadt
Copy link
Owner Author

Thanks will check it out!

@YairHalberstadt
Copy link
Owner Author

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.

@YairHalberstadt YairHalberstadt added this to the 1.0 milestone Oct 15, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants