Talktorial template about teachopencadd

[jaimergp]

It's ok for now. We'll clear everything before merge anyway!

[t-kimber]

Super nice, super clear! Love the template :)

Just a note for MAC users:
in the Render the website locally section, the command which will render the website is open index.html (and not xdg-open index.html).

[jaimergp]

What do you think if we add to the checklist a bullet point concerning populating the README.md in each talktorial folder (title, aim, learning goals, categories) ?

This is going to be automated with a little script. Do take a look at <Talktorial>/data/README.md, tho 😬

[t-kimber]

Just a small detail:

since the reviews branch no longer exists, it might be an idea to change the todo list with package , e.g. git checkout package instead of git checkout reviews?

[dominiquesydow]

Thanks, @jaimergp, for updating the template for the next round of talktorial refactoring :)

[dominiquesydow]

I added (in the template above):

Content review:

• The table of contents reflects the talktorial story-line; order of #, ##, ### headers is correct
• I have spell-checked the notebook
• I have checked that cell outputs are not incredibly long (this applies also to DataFrames)
• Markdown cell content is still in-line with code cell output (whenever results are discussed)

Code review:

• I have marked all code cell with output referenced in markdown cells with the label # TODO: CI
• I have update the relative paths to absolute paths, please add the following lines to the top of the notebook and use those paths

  HERE = Path(_dh[-1])
  DATA = HERE / “data”

[dominiquesydow]

Do we want everyone to push only notebooks without executed cells, @jaimergp? If so, we should add this to the checklist.

[t-kimber]

What do you think if we add to the checklist a bullet point concerning populating the README.md in each talktorial folder (title, aim, learning goals, categories) ?