Skip to content

Commit 19e037f

Browse files
authored
Document headers in practice exercise .append.md files (#592)
2 parents 0bd3b83 + 9d75189 commit 19e037f

1 file changed

Lines changed: 12 additions & 0 deletions

File tree

building/tracks/practice-exercises/README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -178,9 +178,15 @@ A track that doesn't want Bob to support non-ASCII messages, might add the follo
178178
```markdown
179179
# Introduction append
180180

181+
## Note
182+
181183
As part of his teenage rebellion, Bob has decided to only communicate using ASCII.
182184
```
183185

186+
Append files should start with an H1 header.
187+
This header does not get displayed, but should still be present.
188+
The H1 header is often followed by an H2 header, which helps to separate the generic content from the track specific content.
189+
184190
### File: `.docs/instructions.md`
185191

186192
**Purpose:** Provide instructions for the exercise.
@@ -224,9 +230,15 @@ In some (rare) cases, you might want to expand on the exercise's `instructions.m
224230
```markdown
225231
# Instructions append
226232

233+
## Note
234+
227235
Bob's conversational partner is a purist when it comes to written communication and always follows normal rules regarding sentence punctuation in English.
228236
```
229237

238+
Append files should start with an H1 header.
239+
This header does not get displayed, but should still be present.
240+
The H1 header is often followed by an H2 header, which helps to separate the generic content from the track specific content.
241+
230242
### File: `.docs/hints.md`
231243

232244
**Purpose:** Provide hints to a student to help them get themselves unstuck in an exercise.

0 commit comments

Comments
 (0)