Skip to content

Commit 8991aa2

Browse files
Document track mentoring notes (#383)
1 parent 2a178d9 commit 8991aa2

File tree

1 file changed

+18
-4
lines changed

1 file changed

+18
-4
lines changed

building/product/mentoring-notes.md

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,36 @@
11
# Mentoring Notes
22

3-
Mentoring notes are exercise-specific notes aimed to:
3+
There are two types of mentoring notes:
4+
5+
1. Exercise-specific notes (shown for one specific exercise in the track)
6+
2. Track-specific notes (shown for _all_ exercises in the track)
7+
8+
The aim for these notes is to:
49

510
- Make mentoring an exercise easier for mentors
611
- Make mentoring an exercise consistent across mentors
712

813
## What do Mentoring Notes contain?
914

10-
Mentoring notes often contain:
15+
Exercise-specific mentoring notes often contain:
1116

1217
- Examples of reasonable solutions
1318
- Common suggestions/pitfalls
1419
- Talking points
1520

21+
Track-specific mentoring notes often contain:
22+
23+
- Common suggestions/pitfalls (that apply to _all_ exercises)
24+
- Links to useful resources (like a style guide)
25+
1626
## How to add Mentoring Notes
1727

18-
Mentoring notes are stored in the [website-copy repo][website-copy] within a `tracks/<track-slug>/exercises/<exercise-slug>/mentoring.md` file.
19-
To add mentoring notes, submit a PR to add a file following the above file naming pattern.
28+
Mentoring notes are stored in the [website-copy repo][website-copy] using the following file naming patterns:
29+
30+
- Exercise mentoring notes: `tracks/<track-slug>/exercises/<exercise-slug>/mentoring.md`
31+
- Track mentoring notes: `tracks/<track-slug>/mentoring.md`
32+
33+
To add mentoring notes, submit a PR to add a file following the above file naming patterns.
2034

2135
### Why are Mentoring Notes not in the track repo?
2236

0 commit comments

Comments
 (0)