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

review introduction #60

Open
ceisenhauer opened this issue Dec 19, 2024 · 6 comments
Open

review introduction #60

ceisenhauer opened this issue Dec 19, 2024 · 6 comments

Comments

@ceisenhauer
Copy link
Collaborator

ceisenhauer commented Dec 19, 2024

this conversation is a place to discuss points in the review that need more input from the group.

a few from my side:

  • hovertext class needs to be updated to use the new style (see template on the main)
  • as hugo said in the other review, perhaps best to collapse all asides into hovertext (or main text as appropriate)
  • the session (also session 2) have a ton of callouts with upwards of half the text occurring in boxes; this makes the document feel really busy... perhaps some of these callouts could be removed or converted into main text

happy to discuss any of these points.

thanks @MathildeMousset for the draft and @sophiemeakin for your review !

@ceisenhauer ceisenhauer added this to the Core Revision - Splitting milestone Dec 19, 2024
@ceisenhauer ceisenhauer changed the title finalize introduction review introduction Dec 21, 2024
@MathildeMousset
Copy link
Collaborator

  • hovertext class needs to be updated to use the new style (see template on the main)

@MathildeMousset
Copy link
Collaborator

We say that we are going to use two of the tabs during the course: environment and history. But I don't think we get them to use the history tab. Worse, I personnaly never use it. Do you ever?

@MathildeMousset
Copy link
Collaborator

Should we mention list at all? #20 (comment)

  • I am in favor of keeping the very short mention we make of it, to create the correct mental map in the learners, even if we don't use them explicitly now.
  • Sophie is in favour of getting rid of it.

@MathildeMousset
Copy link
Collaborator

IDE: should we consider mentioning others, like VScode or Positron? I wonder what beginers might have heard of in terms if IDE nowadays.

@ceisenhauer
Copy link
Collaborator Author

ceisenhauer commented Jan 6, 2025

We say that we are going to use two of the tabs during the course: environment and history. But I don't think we get them to use the history tab. Worse, I personnaly never use it. Do you ever?

i would remove history; seems low yeild and isn't used elsewhere in the course.

Should we mention list at all? #20 (comment)

  • I am in favor of keeping the very short mention we make of it, to create the correct mental map in the learners, even if we don't use them explicitly now.
  • Sophie is in favour of getting rid of it.

i would remove lists; too much information too early and not something they need to know for any of the other sessions. i think having a satilite about lists could be sensible, though.

IDE: should we consider mentioning others, like VScode or Positron? I wonder what beginers might have heard of in terms if IDE nowadays.

i wouldn't; this information isn't relevant to the rest of the course and so it might add complexity rather than clarity. and we also don't want to encourage different students to use different tools in the course (i have had this in the past and it is super frustrating).


as a general rule, i lean towards as "less is more and even less is better" approach to pedagogy. this material can be really overwhelming to a lot of students and i think we sometimes forget how much people can realistically obsorb. if we put in to much it is unpredictable what will be retained and it may be that they forget the important bits. so i think writing less and then just adding a section at the end that says "want to go further? consider the following satilites" is perhaps a more approachable strategy (to this end, i would probably vote for not linking satilites in the main text unless they are about dependencies and rather putting them in a "going further" section at the end).

@ceisenhauer ceisenhauer linked a pull request Jan 7, 2025 that will close this issue
@ceisenhauer
Copy link
Collaborator Author

i just had a look through the revisions and it looks great ! i made a few small edits, mostly typos and consolidating a couple exercises into a single box if there wasn't any text between it.

@MathildeMousset, @sophiemeakin - if you are happy with the final version of the session i will merge and close.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants