Documentation
-
beautifully-said clear intro to the project purpose for the users -
usage example! -
detailed technical description for contributors -
FAQ area (e.g. "How do I exclude some raw data from the SM build?") -
Contributing links - repo, issue tracker etc. -
Own style? -
Verweis(e) auf SNAKEMAKE DOKU!!! -
Background color is too aggressive -
remove broken links (leading to login-protected sites) -
autodoc (bind Python in-code documentation) for contributors -
Features list - decouple technical features documentation (like .md header parsing, see #37 (closed)) -
Tutorial/Getting started as a separate documentation block (.rst file)? -
Add interlinks in the documentation itself (mostly marked with "(link)") -
Divide webDoc (generated in the HTML output of demo) and normal documentation