esciencecenter-digital-skills / research-software-support

Content for the Research Software Support platform
https://esciencecenter-digital-skills.github.io/research-software-support/
Other
3 stars 4 forks source link

Add Documentation module #104

Closed raar1 closed 3 months ago

raar1 commented 3 months ago

This follows on from the work in PR #31 by:

Fixes #7

raar1 commented 3 months ago

OK, I have now added quite a few extra slides from https://esciencecenter-digital-skills.github.io/digital-skills-slides/ regarding documentation because I think they are quite nice and fit here.

Regarding Sven's remark about the need for an introduction, we can still provide one but IMO the slide deck is now essentially a suitable intro to the module and I've placed it first.

I removed the RS-DAT and Xenon examples that Jaro took exception to (I agreed).

This module can certainly benefit from some polishing, additions etc but I think that it is time to merge this as the first version of the Documentation module so that instructors can start preparing. For any further improvements I propose that we open specific issues to handle these. What do you think @JaroCamphuijsen ?