@@ -84,6 +84,55 @@ This folder acts as the **root scope** for all your learning paths. Supporting a
8484
8585---
8686
87+ ## Front matter
88+
89+
90+ ## 📘 Learning Path Frontmatter
91+
92+ Use this at the top of each ** Learning Path** page (` learning-paths/<orgId>/<slug>/_index.md ` or similar):
93+
94+ ``` yaml
95+ ---
96+ title : " Mastering Kubernetes for Engineers"
97+ description : " Learn how to configure your Kubernetes clusters and manage the lifecycle of your workloads"
98+ banner : null # Optional, URL to banner image
99+ ---
100+ ```
101+
102+ > 📌 Place this frontmatter in the Markdown file that represents the learning path index page.
103+
104+ ---
105+
106+ ## 📗 Course Frontmatter (Optional Individual Course Pages)
107+
108+ If each course has its own markdown page, you can use this frontmatter:
109+
110+ ``` yaml
111+ ---
112+ title : " Kubernetes Basics"
113+ description : " Learn the basics of Kubernetes"
114+ weight : 1
115+ banner : null # Optional
116+ ---
117+ ```
118+
119+ ---
120+
121+ ## ✅ Summary of Required Fields
122+
123+ | Type | Field | Required | Notes |
124+ | ------------- | ------------- | -------- | --------------------------- |
125+ | Learning Path | ` title ` | ✅ | |
126+ | | ` description ` | ✅ | |
127+ | | ` weight ` | ✅ | Defines order in the path |
128+ | | ` banner ` | ❌ | Optional image URI |
129+ | Course | ` title ` | ✅ | |
130+ | | ` description ` | ✅ | |
131+ | | ` weight ` | ✅ | Defines order in the path |
132+ | | ` banner ` | ❌ | Optional image URI |
133+ | | ` prerequisites ` | ❌ | Optional List of prerequisites for the course |
134+
135+
87136## Learning Path Structure
88137
89138Each learning path can include multiple courses, chapters, and lessons, organized in a clear hierarchy.
0 commit comments