carpentries / carpentries/lesson-example

ep6: Do not use subheadings -- really?

Open
#224 4 comments 0 reactions 0 assignees View on GitHub
Dominant language
HTML
Stars
65
Forks
167
PR merge metrics
No merged PRs in 30d

Description

In [episode 4](http://carpentries.github.io/lesson-example/04-formatting/index.html) there is a recommendation not to use sub-titles in episodes.

Perhaps it's a wording ambiguity, but that very page (and indeed the whole lesson example repo) makes extensive use of subtitles - and to good effect; breaking the prose up into navigable chunks. However, no justification is given for this recommendation.

[I was proposing](https://github.com/swcarpentry/matlab-novice-inflammation/issues/150) to use some sub-headings in the MATLAB lesson, and hence this discussion.

I think it will make the lesson material easier to teach and easier to follow for learners.

What are the current thoughts on this?

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.