Skip to content

Fix broken links and improve lesson template structure and readability #1770

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
putku45 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix broken links and improve lesson template structure and readability #1770

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 36 additions & 15 deletions lesson-template/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,30 +1,48 @@
# [Lesson Topic]
# Lesson Topic

![Embed a video here](video-url)
## 🎥 Video

## [Pre-lecture quiz](quiz-url)
> Add an embedded video or lesson link here.

[Describe what we will learn]
---

## Pre-lecture quiz

> Add a quiz link here when available.

---

Provide a brief overview of what students will learn in this lesson.

---

### Introduction

Describe what will be covered
Provide a short introduction describing what will be covered in this lesson.

> Notes

---

### Prerequisite

What steps should have been covered before this lesson?
List the concepts or topics students should already be familiar with before starting this lesson.

---

### Preparation

Preparatory steps to start this lesson
List any setup steps or tools required before starting the lesson.

---

[Step through content in blocks]
### Content

Step through the lesson content in structured sections.

---

## [Topic 1]
## Topic 1

### Task:

Expand All @@ -34,17 +52,20 @@ Work together to progressively enhance your codebase to build the project with s
code blocks
```

✅ Knowledge Check - use this moment to stretch students' knowledge with open questions
✅ Knowledge Check
Use this moment to stretch students' knowledge with open-ended questions.

## [Topic 2]
## Topic 2
## Topic 3

## [Topic 3]
🚀 Challenge
Add a collaborative challenge for students to enhance the project.

🚀 Challenge: Add a challenge for students to work on collaboratively in class to enhance the project
Optional: Add a screenshot of the completed lesson's UI if appropriate.

Optional: add a screenshot of the completed lesson's UI if appropriate
## Post-lecture quiz

## [Post-lecture quiz](quiz-url)
Add a quiz link here after completing the lesson.

## Review & Self Study

Expand Down