differences for PR #412

carpentries · Sep 12, 2024 · 4df0cf0 · 4df0cf0
1 parent db10434
commit 4df0cf0
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 3 deletions.
diff --git a/lesson-content.md b/lesson-content.md
@@ -133,12 +133,12 @@ and copy its content into your episode.
 
 ```markdown
 ---
-title: "Using Markdown"
+title: "Intro to Markdown"
 teaching: 10
 exercises: 2
 ---
 
-:::::::::::::::::::::::::::::::::::::: questions
+:::::::::::::::::::::::::::::::::::::: questions 
 
 - How do you write a lesson using Markdown and `{sandpaper}`?
 
@@ -149,6 +149,25 @@ exercises: 2
 - Explain how to use markdown with The Carpentries Workbench
 - Demonstrate how to include pieces of code, figures, and nested challenge blocks
 
+::::::::::::::::::::::::::::::::::::::::::::::::
+
+## Introduction
+
+This is a lesson created via The Carpentries Workbench. It is written in
+[Pandoc-flavored Markdown](https://pandoc.org/MANUAL.txt) for static files and
+[R Markdown][r-markdown] for dynamic files that can render code into output. 
+Please refer to the [Introduction to The Carpentries 
+Workbench](https://carpentries.github.io/sandpaper-docs/) for full documentation.
+
+...
+
+::::::::::::::::::::::::::::::::::::: keypoints 
+
+- Use `.md` files for episodes when you want static content
+- Use `.Rmd` files for episodes when you need to generate output
+- Run `sandpaper::check_lesson()` to identify any issues with your lesson
+- Run `sandpaper::build_lesson()` to preview your lesson locally
+
 ::::::::::::::::::::::::::::::::::::::::::::::::
 ```
 

diff --git a/md5sum.txt b/md5sum.txt
@@ -18,7 +18,7 @@
 "episodes/explanation.md" "32ae9dfcb32a48e17bea7588275e8d5d" "site/built/explanation.md" "2024-09-11"
 "episodes/long-break2.md" "3a4802231bb8e44cc6c132d86afb7f78" "site/built/long-break2.md" "2023-08-21"
 "episodes/infrastructure.md" "8c7f89493f7b99cb2c50db85bba79c0e" "site/built/infrastructure.md" "2024-09-09"
-"episodes/lesson-content.md" "c79277f733c272a2557aba76aca287b0" "site/built/lesson-content.md" "2024-09-09"
+"episodes/lesson-content.md" "b37e3906aedebab696dc0aa39a247ffe" "site/built/lesson-content.md" "2024-09-12"
 "episodes/short-break4.md" "05d1044278ce40ab59d9397db1f0e383" "site/built/short-break4.md" "2023-08-21"
 "episodes/operations.md" "0728992ef58414f5a93e264ac7522002" "site/built/operations.md" "2024-06-26"
 "episodes/preparing.md" "bc0f9721ebd9108ff17ec3933b58a705" "site/built/preparing.md" "2024-09-09"