Questions regarding the structure of this repo and its materials

[nmnobre]

Hi,

I'm a bit confused regarding the general structure of the repo and its materials, so I thought I'd ask:

1. It is my understanding that index.html holds the most up-to-date lecture material and that the pdf is provided just for convenience. How can we make sure that they don't get out of sync? In particular, how do you guys normally generate the pdf?
   Addressed in Add instructions to export as pdf and remove broken link #241.
   (I'll do my bit and regenerate all pdf files once my PRs are merged 🙂)

2. I think the trend has been to move all the image assets under Lesson_Materials/common-revealjs? If that's the case, we could probably move all remaining images there and remove duplicates?
   Addressed in Tidy up the slide diagrams #240.

3. Does it make sense for the exercises to pass the Catch2 tests even if the user/learner doesn't touch them, or should we rewrite them so the exercises fail unless the task is completed? As is, maybe I'd vote for the removal of Catch2 as suggested in Remove Catch2? #148.

Cheers,
-Nuno

[AerialMantis]

Hi @nmnobre,

Thanks for your questions, I'll give my thoughts:

1. That's right, the pdfs are just for convenience as you can't view the rendered version via the browser and you need to clone the repository, I believe we try to rebuild the pdfs frequently, though perhaps automating this would avoid them falling out of sync.
2. Yes, we've moved a lot of the images to the common directory to make it easier for them to be re-used across lectures, so I think moving them all there probably makes sense.
3. This was the idea originally, that the solution would pass but the source would fail as it would either be empty or partially implemented, though I don't think all exercises would fail if not implemented. I'm also fine with removing Catch2, we used it originally as it provided a simple way to run the exercises, but I agree it's a bit overkill.