There are two types of mentoring notes:
The aim for these notes is to:
Exercise-specific mentoring notes often contain:
Track-specific mentoring notes often contain:
Mentoring notes are stored in the website-copy repo using the following file naming patterns:
To add mentoring notes, submit a PR to add a file following the above file naming patterns.
Maintaining a track is quite different from writing mentoring notes and requires different skills. Therefore, the people writing mentoring notes should not necessarily be the same people that are maintaining a track.
If we would store the mentoring notes within the track's repo, maintainers would have to sign off on any mentoring note PRs before they can be merged (or at least they'd be notified for each mentoring note change). Storing the mentoring notes in the website-copy repo allows us to: