# lesson-template-generator

> The Lesson Template Generator creates consistent, structured lesson files with frontmatter and 7 mandatory sections. This skill ensures all lessons follow the same format, making content creation easier and maintaining consistency across the entire textbook.

- Author: Alishba Basharat
- Repository: AlishbaBasharat/PHASE-03
- Version: 20260109021707
- Stars: 0
- Forks: 0
- Last Updated: 2026-02-08
- Source: https://github.com/AlishbaBasharat/PHASE-03
- Web: https://mule.run/skillshub/@@AlishbaBasharat/PHASE-03~lesson-template-generator:20260109021707

---

# Lesson Template Generator Skill

**Status**: ✅ Active - Phase 1 Implementation

**Purpose**: Generates standardized lesson markdown files with all required sections for the Physical AI & Humanoid Robotics textbook.

---

## Overview

The Lesson Template Generator creates consistent, structured lesson files with frontmatter and 7 mandatory sections. This skill ensures all lessons follow the same format, making content creation easier and maintaining consistency across the entire textbook.

---

## Phase 1 Usage Strategy

**Active Role**: Used by Content Architect to create ALL 6 lesson files

**Content Strategy**:
- **Lessons 1.1, 2.1, 3.1**: Templates REPLACED by Technical Writer with full content
- **Lessons 1.2, 2.2, 3.2**: KEEP the template as placeholder content (sidebar display only)

This approach balances:
- Time constraints (Sunday deadline)
- Demonstration value (3 complete lessons show capability)
- User experience (6 lessons visible in sidebar for structure)

---

## Template Structure

### Frontmatter (YAML)

```yaml
---
sidebar_position: [POSITION_NUMBER]
title: [LESSON_TITLE]
description: [BRIEF_DESCRIPTION]
---
```

**Fields**:
- `sidebar_position`: Integer (1, 2, 3...) - determines order in sidebar
- `title`: String - full lesson title displayed in sidebar and page header
- `description`: String - brief summary for SEO and metadata

---

### Template Output

```markdown
---
sidebar_position: 1
title: [LESSON_TITLE]
description: [BRIEF_DESCRIPTION]
---

# [LESSON_TITLE]

## Introduction

[Why this lesson matters - 2-3 sentences explaining the importance and context of this topic in Physical AI and Humanoid Robotics]

## Learning Objectives

By the end of this lesson, you will be able to:

- [ ] [Objective 1 - using action verb: understand, explain, implement, etc.]
- [ ] [Objective 2 - specific, measurable outcome]
- [ ] [Objective 3 - practical application or skill]

## Key Concepts

### [Concept 1 Title]

[Detailed explanation of the first key concept. Include:
- Clear definition
- How it works
- Why it's important
- Real-world examples from robotics/AI]

### [Concept 2 Title]

[Explanation of the second key concept with similar depth]

### [Concept 3 Title]

[Explanation of the third key concept]

## Hands-on Exercise

[Step-by-step practical activity that reinforces the learning objectives]

**Prerequisites**:
- [Required knowledge or tools]
- [Software/hardware requirements]

**Steps**:
1. [Step 1 with clear instructions]
2. [Step 2 building on previous step]
3. [Step 3 leading to completion]

**Expected Outcome**:
[What students should achieve or understand after completing this exercise]

## Quiz

Test your understanding of this lesson:

1. [Multiple choice question testing Concept 1]
   - A) [Option A]
   - B) [Option B]
   - C) [Option C]
   - D) [Option D]

2. [Multiple choice question testing Concept 2]
   - A) [Option A]
   - B) [Option B]
   - C) [Option C]
   - D) [Option D]

3. [Application question testing practical understanding]
   - A) [Option A]
   - B) [Option B]
   - C) [Option C]
   - D) [Option D]

<details>
<summary>Show Answers</summary>

1. [Correct answer letter] - [Brief explanation of why this is correct]
2. [Correct answer letter] - [Explanation]
3. [Correct answer letter] - [Explanation]

</details>

## Key Takeaways

- [Summary point 1 - most critical concept from this lesson]
- [Summary point 2 - key skill or application]
- [Summary point 3 - important warning or best practice]

## Further Reading

- [Resource 1: Official Documentation or Tutorial](#) - [Brief description of what this covers]
- [Resource 2: Research Paper or Advanced Guide](#) - [Description]
- [Resource 3: Community Resource or Tool](#) - [Description]

---

**Next Lesson**: [Next Lesson Title](./lesson-[next-number]-[slug].md)
```

---

## Usage Instructions

### For Content Architect Subagent

The Content Architect uses this template when generating lesson files:

1. **Parse lesson information** from COURSE_CONTENT.md
2. **Replace placeholders**:
   - `[LESSON_TITLE]` → Actual lesson title
   - `[BRIEF_DESCRIPTION]` → Extract from course content
   - `[POSITION_NUMBER]` → Lesson number (1, 2, etc.)
3. **Keep placeholder text** in sections (Introduction, Key Concepts, etc.)
4. **Write file** to `docs/docs/chapter-XX-slug/lesson-XX-slug.md`

### For Technical Writer Subagent

The Technical Writer replaces template content for lessons 1.1, 2.1, 3.1:

1. **Read existing lesson file** generated by Content Architect
2. **Replace placeholder text** with actual content:
   - Introduction: Write compelling 2-3 sentence intro
   - Learning Objectives: Create specific, measurable objectives
   - Key Concepts: Write detailed explanations with examples
   - Hands-on Exercise: Design practical activity with clear steps
   - Quiz: Create meaningful assessment questions
   - Key Takeaways: Summarize most important points
   - Further Reading: Add real resources with URLs
3. **Preserve frontmatter** (sidebar_position, title, description)
4. **Write updated file** back to same location

---

## 7 Mandatory Sections

All lesson files MUST include these sections:

1. ✅ **Introduction** - Context and importance
2. ✅ **Learning Objectives** - What students will learn
3. ✅ **Key Concepts** - Core ideas explained in depth
4. ✅ **Hands-on Exercise** - Practical application
5. ✅ **Quiz** - Assessment with answers
6. ✅ **Key Takeaways** - Summary points
7. ✅ **Further Reading** - Additional resources

---

## Validation Rules

**Frontmatter**:
- Must be valid YAML
- Must include all 3 required fields
- sidebar_position must be integer

**Content**:
- All 7 sections must be present
- Section headers must use `##` (level 2 heading)
- Quiz answers must be in `<details>` tag
- Learning Objectives must use checkboxes `- [ ]`

**Links**:
- "Next Lesson" link must point to next lesson file (relative path)
- Further Reading links can be placeholders (#) until filled by Technical Writer

---

## Examples

### Example: Chapter 1, Lesson 1

```markdown
---
sidebar_position: 1
title: Introduction to Embodied Intelligence
description: Foundations of Physical AI and embodied intelligence principles
---

# Introduction to Embodied Intelligence

## Introduction

Embodied intelligence represents a paradigm shift in artificial intelligence...
[Full content written by Technical Writer]

## Learning Objectives

By the end of this lesson, you will be able to:

- [ ] Define embodied intelligence and explain how it differs from traditional AI
- [ ] Identify real-world applications of Physical AI in humanoid robotics
- [ ] Understand the key challenges in creating AI systems that interact with the physical world

## Key Concepts

### What is Embodied Intelligence?

[Detailed explanation...]

### The Physical World Constraint

[Explanation...]

### Sensor-Motor Integration

[Explanation...]

[... rest of sections ...]
```

---

## Integration with Other Skills

**Works with**:
- **Chapter Scaffolder**: Receives chapter/lesson structure, generates lesson files
- **Sidebar Config Updater**: Lesson frontmatter (`sidebar_position`, `title`) drives sidebar ordering
- **Cross-Reference Linker**: "Next Lesson" links connect lessons sequentially

**Used by**:
- **Content Architect Subagent**: Primary consumer - generates all 6 lesson files
- **Technical Writer Subagent**: Replaces template content for 3 full lessons

---

## Performance

**Generation Speed**: <1 second per lesson file
**File Size**: ~2-3 KB per template file

---

## Future Enhancements (Post-Hackathon)

- Custom template variations per chapter
- Difficulty level indicators
- Estimated completion time
- Code block syntax highlighting hints
- Diagram placeholders with Mermaid support

---

**Version**: 1.0.0
**Status**: Active (Phase 1)
**Last Updated**: 2025-11-28
**Author**: IqraNaz421