Skip to content

Figure and text in Introduction section are redundant #12

@jlcohoon

Description

@jlcohoon

Related to issue #7

The figure after Exercise 1 is meant to summarize the content that follows, but this isn't immediately obvious and so lesson readers are likely to read the figure and the text, making their learning time unnecessarily longer. Below are some thoughts on how to address the issue, but other contributors might have different ideas. A goal is to make the content more easily skimmed.

Possible approaches to reducing redundancy and time required for learning:

  • cut the figure
  • make some of the content bullet points

Before addressing this issue, please leave a comment describing your approach so that others can assist without duplicating work. Tag a reviewer (e.g. @jlcohoon) as well.
Please check that the "Overview" and "Key Points" don't need adjusting after your edits

Carpentries info on formatting the different kinds of callouts and collapsable content like exercises might be useful: https://carpentries.github.io/sandpaper-docs/instructor/component-guide.html
https://carpentries.github.io/lesson-development-training/lesson-content.html#adding-exercises

Metadata

Metadata

Assignees

No one assigned

    Labels

    medium effortsome UX or Carpentries expertise needed and/or may be somewhat time consuming taskssmall effortbite sized tasks with minimal expertise neededsome direction provideda little guidance on how to address the issue is provided

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions