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

High-level overview of the pedagogical structure #332

Closed
lesteve opened this issue May 6, 2021 · 5 comments
Closed

High-level overview of the pedagogical structure #332

lesteve opened this issue May 6, 2021 · 5 comments

Comments

@lesteve
Copy link
Collaborator

lesteve commented May 6, 2021

Now that the course content is a bit more mature, should we create a single document kind of summarising the key elements of each notebook so that we can have an idea of the high-level pedagogical structure? This would be a single document so maybe this is a rehash of plan.md that never really worked ...

This helps having a high-level overview of the full content. Very often when changing something locally:

  • you don't realise that you need to change it in other places
  • that the pedagogical sequence is a bit weird once you change it
  • or that originally we did that because we thought we would not introduce a notion until a later module.

Should this be automatically generated (probably not)?

Should we do it now that the course content is fresh in our minds?

Maybe this is YAGNI I don't know

@GaelVaroquaux
Copy link
Collaborator

GaelVaroquaux commented May 6, 2021 via email

@lfarhi
Copy link
Collaborator

lfarhi commented May 6, 2021

We have a table of content in the Mooc : https://lms.fun-mooc.fr/courses/course-v1:inria+41026+session01/496272d6f8444957a7014122a4646116/ and it is very usefull even if we could improve it with some collapse elements. Is it somethink similar that you wish @lesteve ?

@lesteve
Copy link
Collaborator Author

lesteve commented May 6, 2021

For me this is more a single document that includes the table of content but also some text explaining the idea behind each notebook so that we can use it to see the full story of the MOOC (more for us as content writers than anything else).

I'll open a separate issue about having the equivalent of the FUN table of contents, I agree this would be useful to quickly make sure that the contents haven't drifted too much away between FUN and the JupyterBook (issue is now created #335).

@ArturoAmorQ
Copy link
Collaborator

should we create a single document kind of summarising the key elements of each notebook so that we can have an idea of the high-level pedagogical structure?

Maybe a table of contents similar to the one that I use in #398 could come useful for this purpose. Of course my notation can be improved using navigation tools, but it does help keeping track of the pedagogical structure.

Should we do it now that the course content is fresh in our minds?

I am expanding it while following the MOOC.

@lesteve
Copy link
Collaborator Author

lesteve commented Jan 6, 2022

Let's close this, I don't think this is realistic to have something like this unfortunately ...

Also there is the table of contents now: https://inria.github.io/scikit-learn-mooc/toc.html

@lesteve lesteve closed this as completed Jan 6, 2022
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

4 participants