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

Noob-Documentation #33

Open
cstenkamp opened this issue Nov 27, 2020 · 1 comment
Open

Noob-Documentation #33

cstenkamp opened this issue Nov 27, 2020 · 1 comment
Assignees

Comments

@cstenkamp
Copy link
Collaborator

Hello Frankie,
As I've needed to spend quite some time reading into this codebase and we don't want that to be a waste, I've discussed with Peter that it may make sense to create a "Noob-Documentation". As I've for example never even encountered Snakemake or Singularity before, I think it makes sense to explain things at a very basic level, additionally to the (very helpful, believe me, without it I'd be completely lost!) documentation you've created in the past few days. So would you be fine with me adding a few pages to your documentation?

@cstenkamp cstenkamp self-assigned this Nov 27, 2020
@frankier
Copy link
Owner

Yes please! It seems from my slightly rushed work so far on the docs that they can always be improved. I did already try to divide the docs into two (user/dev) and try to make the first more approachable, but yes there could be more context, more "what is it?" and "why is it like this?" (why oh why is it like this 😉).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants