From 4f3b70f56eac684216b119a61f0352f4375dcb93 Mon Sep 17 00:00:00 2001 From: Isaac Good Date: Mon, 25 May 2026 15:26:35 -0700 Subject: [PATCH 1/4] Document headers in practice exercise append files --- building/tracks/practice-exercises/README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/building/tracks/practice-exercises/README.md b/building/tracks/practice-exercises/README.md index 0d43c4f9..be7aa185 100644 --- a/building/tracks/practice-exercises/README.md +++ b/building/tracks/practice-exercises/README.md @@ -178,9 +178,15 @@ A track that doesn't want Bob to support non-ASCII messages, might add the follo ```markdown # Introduction append +## Note + As part of his teenage rebellion, Bob has decided to only communicate using ASCII. ``` +Note, append files should start with an H1 header. +This header does not get displayed, but should still be present. +The H1 header should be followed by an H2 header, which helps to separate the generic content from the track specific content. + ### File: `.docs/instructions.md` **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 ```markdown # Instructions append +## Note + Bob's conversational partner is a purist when it comes to written communication and always follows normal rules regarding sentence punctuation in English. ``` +Note, append files should start with an H1 header. +This header does not get displayed, but should still be present. +The H1 header should be followed by an H2 header, which helps to separate the generic content from the track specific content. + ### File: `.docs/hints.md` **Purpose:** Provide hints to a student to help them get themselves unstuck in an exercise. From 465ece83c5ee65013a97fa4d5a3432753e7d4fa6 Mon Sep 17 00:00:00 2001 From: Isaac Good Date: Mon, 25 May 2026 22:01:39 -0700 Subject: [PATCH 2/4] Soften language: `s/should/is often/` --- building/tracks/practice-exercises/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/building/tracks/practice-exercises/README.md b/building/tracks/practice-exercises/README.md index be7aa185..6313c529 100644 --- a/building/tracks/practice-exercises/README.md +++ b/building/tracks/practice-exercises/README.md @@ -185,7 +185,7 @@ As part of his teenage rebellion, Bob has decided to only communicate using ASCI Note, append files should start with an H1 header. This header does not get displayed, but should still be present. -The H1 header should be followed by an H2 header, which helps to separate the generic content from the track specific content. +The H1 header is often followed by an H2 header, which helps to separate the generic content from the track specific content. ### File: `.docs/instructions.md` @@ -237,7 +237,7 @@ Bob's conversational partner is a purist when it comes to written communication Note, append files should start with an H1 header. This header does not get displayed, but should still be present. -The H1 header should be followed by an H2 header, which helps to separate the generic content from the track specific content. +The H1 header is often followed by an H2 header, which helps to separate the generic content from the track specific content. ### File: `.docs/hints.md` From 07a1386c8e700b24a1d7472a7cbea815ea5719c1 Mon Sep 17 00:00:00 2001 From: Isaac Good Date: Tue, 26 May 2026 08:46:32 -0700 Subject: [PATCH 3/4] Update building/tracks/practice-exercises/README.md Co-authored-by: Derk-Jan Karrenbeld --- building/tracks/practice-exercises/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/building/tracks/practice-exercises/README.md b/building/tracks/practice-exercises/README.md index 6313c529..106eea72 100644 --- a/building/tracks/practice-exercises/README.md +++ b/building/tracks/practice-exercises/README.md @@ -183,7 +183,7 @@ A track that doesn't want Bob to support non-ASCII messages, might add the follo As part of his teenage rebellion, Bob has decided to only communicate using ASCII. ``` -Note, append files should start with an H1 header. +Append files should start with an H1 header. This header does not get displayed, but should still be present. The H1 header is often followed by an H2 header, which helps to separate the generic content from the track specific content. From 9d75189fa1cb79a7310368f2240812215a7d673c Mon Sep 17 00:00:00 2001 From: Isaac Good Date: Tue, 26 May 2026 08:46:40 -0700 Subject: [PATCH 4/4] Update building/tracks/practice-exercises/README.md Co-authored-by: Derk-Jan Karrenbeld --- building/tracks/practice-exercises/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/building/tracks/practice-exercises/README.md b/building/tracks/practice-exercises/README.md index 106eea72..820283ee 100644 --- a/building/tracks/practice-exercises/README.md +++ b/building/tracks/practice-exercises/README.md @@ -235,7 +235,7 @@ In some (rare) cases, you might want to expand on the exercise's `instructions.m Bob's conversational partner is a purist when it comes to written communication and always follows normal rules regarding sentence punctuation in English. ``` -Note, append files should start with an H1 header. +Append files should start with an H1 header. This header does not get displayed, but should still be present. The H1 header is often followed by an H2 header, which helps to separate the generic content from the track specific content.