@datajaddah/course 0.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +31 -0
- package/bin/datajaddah-course.js +238 -0
- package/lib/init.js +375 -0
- package/lib/preview.js +1617 -0
- package/lib/repo-contract.js +1291 -0
- package/lib/slide-markdown.js +505 -0
- package/package.json +41 -0
- package/preview-dist/assets/index-CJUgarn8.css +1 -0
- package/preview-dist/assets/index-CavDNP3d.js +49 -0
- package/preview-dist/index.html +13 -0
- package/scaffold/.agents/rules/general.md +91 -0
- package/scaffold/.agents/skills/course-coding-exercises/SKILL.md +22 -0
- package/scaffold/.agents/skills/course-coding-exercises/references/coding-exercises.md +111 -0
- package/scaffold/.agents/skills/course-platform-overview/SKILL.md +36 -0
- package/scaffold/.agents/skills/course-platform-overview/references/platform-overview.md +105 -0
- package/scaffold/.agents/skills/course-quizzes/SKILL.md +23 -0
- package/scaffold/.agents/skills/course-quizzes/references/quizzes.md +121 -0
- package/scaffold/.agents/skills/course-repo-contract/SKILL.md +24 -0
- package/scaffold/.agents/skills/course-repo-contract/references/repo-contract.md +169 -0
- package/scaffold/.agents/skills/course-slides-v2/SKILL.md +28 -0
- package/scaffold/.agents/skills/course-slides-v2/references/fit-guidance.md +31 -0
- package/scaffold/.agents/skills/course-slides-v2/references/slides-v2.md +138 -0
- package/scaffold/.agents/skills/course-spreadsheet-labs/SKILL.md +23 -0
- package/scaffold/.agents/skills/course-spreadsheet-labs/references/spreadsheet-labs.md +239 -0
- package/scaffold/.agents/skills/course-video-lessons/SKILL.md +22 -0
- package/scaffold/.agents/skills/course-video-lessons/references/video-lessons.md +83 -0
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
# Video Lessons
|
|
2
|
+
|
|
3
|
+
## Files
|
|
4
|
+
|
|
5
|
+
Inside a video lesson:
|
|
6
|
+
|
|
7
|
+
```text
|
|
8
|
+
lesson.md
|
|
9
|
+
video.md
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
`lesson.md` must contain:
|
|
13
|
+
|
|
14
|
+
```md
|
|
15
|
+
---
|
|
16
|
+
kind: video
|
|
17
|
+
title: "Lesson Title"
|
|
18
|
+
---
|
|
19
|
+
Optional lesson summary.
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
`video.md` must contain:
|
|
23
|
+
|
|
24
|
+
```md
|
|
25
|
+
---
|
|
26
|
+
title: "Video Title"
|
|
27
|
+
video_url: "https://www.youtube.com/watch?v=dQw4w9WgXcQ"
|
|
28
|
+
---
|
|
29
|
+
Optional learner notes, references, or follow-up prompts.
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
## Decision Rule
|
|
33
|
+
|
|
34
|
+
- Use `video.md` only when the user already has a real external video URL or explicitly wants a standalone linked video lesson.
|
|
35
|
+
- If the lesson is primarily an explanation of slides, author it as `slides` with `@script` instead.
|
|
36
|
+
- Do not invent placeholder URLs. Validation rejects obvious placeholders such as `example.com` and `replace-me`.
|
|
37
|
+
|
|
38
|
+
## Required Data
|
|
39
|
+
|
|
40
|
+
- `video_url` is required.
|
|
41
|
+
|
|
42
|
+
## Optional Data
|
|
43
|
+
|
|
44
|
+
- `title`
|
|
45
|
+
- markdown notes in the body
|
|
46
|
+
|
|
47
|
+
## Platform Behavior
|
|
48
|
+
|
|
49
|
+
- The platform stores one external `video_url` for the lesson resource.
|
|
50
|
+
- The student app renders that URL directly as the video source.
|
|
51
|
+
- Local preview can embed common YouTube URLs and can fall back to a plain video or link view depending on the URL.
|
|
52
|
+
- This is the exception path for externally hosted videos. Most course explainer videos are created later on the platform from slide content plus narration audio.
|
|
53
|
+
|
|
54
|
+
## Practical Guidance
|
|
55
|
+
|
|
56
|
+
- Use stable, shareable URLs.
|
|
57
|
+
- Use a real URL that already points to the intended video.
|
|
58
|
+
- Keep notes learner-facing: what to watch for, what to do after the video, what to review.
|
|
59
|
+
- Do not dump a transcript into `video.md` unless the user explicitly asks for that.
|
|
60
|
+
- Prefer summaries, checkpoints, or references over repeating the entire video content.
|
|
61
|
+
|
|
62
|
+
## Out Of Scope
|
|
63
|
+
|
|
64
|
+
- uploaded binary video assets
|
|
65
|
+
- platform rendering jobs
|
|
66
|
+
- slide narration video generation
|
|
67
|
+
- timing metadata
|
|
68
|
+
|
|
69
|
+
## Example
|
|
70
|
+
|
|
71
|
+
```md
|
|
72
|
+
---
|
|
73
|
+
title: "Build And Run The API"
|
|
74
|
+
video_url: "https://www.youtube.com/watch?v=dQw4w9WgXcQ"
|
|
75
|
+
---
|
|
76
|
+
Watch this video before attempting the exercise.
|
|
77
|
+
|
|
78
|
+
Focus on:
|
|
79
|
+
|
|
80
|
+
- the environment variables that must exist
|
|
81
|
+
- the order of the startup commands
|
|
82
|
+
- the most common local setup failures
|
|
83
|
+
```
|