omnilearn-workflow 1.0.7 → 1.0.9
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.
|
@@ -28,7 +28,7 @@ Both scenarios follow the same core flow: research → analyze → produce struc
|
|
|
28
28
|
<skill>/ ← Skill at learning directory root
|
|
29
29
|
├── roadmap.md
|
|
30
30
|
├── SkillPreferences.md
|
|
31
|
-
├── SkillConventions.md ←
|
|
31
|
+
├── SkillConventions.md ← Setup conventions read for consistent diagnostic tasks
|
|
32
32
|
├── progress-index.md
|
|
33
33
|
├── runs/
|
|
34
34
|
│ └── YYYY-MM-DD-HHMMSS-refine-<topic>/
|
|
@@ -40,7 +40,14 @@ Both scenarios follow the same core flow: research → analyze → produce struc
|
|
|
40
40
|
└── <topic>/
|
|
41
41
|
├── topic-roadmap.md ← Will be updated if refined
|
|
42
42
|
├── topic-explanation.md ← Theory foundation (updated if refined)
|
|
43
|
+
├── topic-progress.md ← Progress state (preserved)
|
|
43
44
|
├── assignments/ ← May be added to if needed
|
|
45
|
+
│ ├── 01-<concept>/
|
|
46
|
+
│ │ ├── question.md
|
|
47
|
+
│ │ ├── test.<ext>
|
|
48
|
+
│ │ ├── scaffold/
|
|
49
|
+
│ │ └── solution-guide.md
|
|
50
|
+
│ └── ...
|
|
44
51
|
└── runs/
|
|
45
52
|
```
|
|
46
53
|
|
|
@@ -73,12 +73,19 @@ This command performs the same rigorous research-backed process as `/omnilearn-r
|
|
|
73
73
|
│ ├── research-changes.md ← Research on requested changes
|
|
74
74
|
│ ├── old-roadmap-archived.md ← Previous version of roadmap
|
|
75
75
|
│ └── new-roadmap-draft.md ← Draft of updated roadmap
|
|
76
|
-
└── topics/ ← MUST be preserved — never delete or alter
|
|
76
|
+
└── topics/ ← MUST be preserved — never delete or alter
|
|
77
77
|
└── <topic-name>/
|
|
78
|
+
├── topic-roadmap.md
|
|
78
79
|
├── topic-explanation.md ← Theory foundation (read before assignments)
|
|
79
|
-
├── topic-progress.md ← 🔑
|
|
80
|
-
├── assignments/ ←
|
|
81
|
-
|
|
80
|
+
├── topic-progress.md ← 🔑 Source of truth for user progress
|
|
81
|
+
├── assignments/ ← MUST NOT be modified
|
|
82
|
+
│ ├── 01-<concept>/
|
|
83
|
+
│ │ ├── question.md
|
|
84
|
+
│ │ ├── test.<ext>
|
|
85
|
+
│ │ ├── scaffold/
|
|
86
|
+
│ │ └── solution-guide.md
|
|
87
|
+
│ └── ...
|
|
88
|
+
└── runs/ ← Action logs only
|
|
82
89
|
```
|
|
83
90
|
|
|
84
91
|
**Progress Inventory — Every edit must account for each topic's full state before making changes.**
|
|
@@ -15,35 +15,35 @@ description: Create a comprehensive, real-world-ready learning roadmap for any s
|
|
|
15
15
|
## Directory Structure
|
|
16
16
|
|
|
17
17
|
```
|
|
18
|
-
|
|
19
|
-
├──
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
├──
|
|
25
|
-
├──
|
|
26
|
-
├──
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
│
|
|
30
|
-
│ ├──
|
|
31
|
-
│ └──
|
|
32
|
-
└── topics/ ← Topics in the roadmap
|
|
33
|
-
└── <topic-name>/ ←
|
|
34
|
-
├── topic-roadmap.md ← Detailed subtopic roadmap
|
|
35
|
-
├──
|
|
36
|
-
├── topic-progress.md ←
|
|
37
|
-
├── assignments/
|
|
18
|
+
{learningDirectory}/
|
|
19
|
+
├── .omnilearn/ ← ONLY config + global prefs
|
|
20
|
+
│ ├── config.json
|
|
21
|
+
│ └── UserPreferences.md
|
|
22
|
+
│
|
|
23
|
+
└── <skill-name>/ ← Skills at learning directory ROOT
|
|
24
|
+
├── SkillPreferences.md ← Per-skill learning preferences
|
|
25
|
+
├── SkillConventions.md ← Setup conventions (auto-learned)
|
|
26
|
+
├── roadmap.md ← Master roadmap
|
|
27
|
+
├── progress-index.md ← Progress overview
|
|
28
|
+
├── runs/ ← Skill-level run logs
|
|
29
|
+
│ └── YYYY-MM-DD-HHMMSS-<activity>/
|
|
30
|
+
│ ├── agent-log.md
|
|
31
|
+
│ └── ...
|
|
32
|
+
└── topics/ ← Topics in the roadmap
|
|
33
|
+
└── <topic-name>/ ← One per topic
|
|
34
|
+
├── topic-roadmap.md ← Detailed subtopic roadmap
|
|
35
|
+
├── topic-explanation.md ← Theory: TL;DR → concepts → examples → pitfalls
|
|
36
|
+
├── topic-progress.md ← 🔑 Progress: assignments, sessions, skills
|
|
37
|
+
├── assignments/
|
|
38
38
|
│ ├── 01-<concept>/
|
|
39
|
-
│ │ ├── question.md ← Real-world scenario
|
|
40
|
-
│ │ ├── test.<ext> ← Automated
|
|
41
|
-
│ │ ├── scaffold/ ← Starter code
|
|
42
|
-
│ │ └── solution-guide.md ← Reference solution
|
|
43
|
-
│ └── ...
|
|
44
|
-
└── runs/ ← Per-topic action logs
|
|
39
|
+
│ │ ├── question.md ← Real-world scenario
|
|
40
|
+
│ │ ├── test.<ext> ← Automated tests
|
|
41
|
+
│ │ ├── scaffold/ ← Starter code
|
|
42
|
+
│ │ └── solution-guide.md ← Reference solution
|
|
43
|
+
│ └── 02-<concept>/ ...
|
|
44
|
+
└── runs/ ← Per-topic action logs
|
|
45
45
|
└── YYYY-MM-DD-HHMMSS-<activity>/
|
|
46
|
-
├── agent-log.md
|
|
46
|
+
├── agent-log.md
|
|
47
47
|
└── ...
|
|
48
48
|
```
|
|
49
49
|
|
|
@@ -339,13 +339,46 @@ task(category="deep", run_in_background=false, timeout=600000, prompt="
|
|
|
339
339
|
- Import/require statements already in place
|
|
340
340
|
- Can be empty scaffold if topic is conceptual
|
|
341
341
|
|
|
342
|
-
d) solution-guide.md:
|
|
343
|
-
|
|
344
|
-
|
|
345
|
-
|
|
346
|
-
|
|
347
|
-
|
|
348
|
-
|
|
342
|
+
d) solution-guide.md — CRITICAL: Must be researched, accurate, and complete.
|
|
343
|
+
|
|
344
|
+
BEFORE writing the solution:
|
|
345
|
+
1. Use google_search / context7_query-docs to research the CORRECT approach for this specific problem.
|
|
346
|
+
2. Verify your solution compiles/runs correctly — test it mentally or note any assumptions.
|
|
347
|
+
3. Cross-reference with topic-explanation.md to ensure consistency.
|
|
348
|
+
4. If the topic involves a library/framework, check official docs via context7 to confirm API accuracy.
|
|
349
|
+
|
|
350
|
+
The solution-guide.md must have this structure:
|
|
351
|
+
|
|
352
|
+
## Solution Overview
|
|
353
|
+
- What approach was taken and why (1 paragraph)
|
|
354
|
+
- Key decisions made and the tradeoffs considered
|
|
355
|
+
|
|
356
|
+
## Complete Solution
|
|
357
|
+
```{language}
|
|
358
|
+
# The full, working solution code
|
|
359
|
+
# Each section commented with WHY, not just WHAT
|
|
360
|
+
```
|
|
361
|
+
|
|
362
|
+
## Step-by-Step Explanation
|
|
363
|
+
- Break the solution into logical steps
|
|
364
|
+
- For each step: what it does, why it's done this way, what would happen if you did it differently
|
|
365
|
+
- Reference the topic-explanation.md concepts being applied
|
|
366
|
+
|
|
367
|
+
## Edge Cases Handled
|
|
368
|
+
- List edge cases the solution handles
|
|
369
|
+
- What would break if not handled
|
|
370
|
+
|
|
371
|
+
## Alternative Approaches
|
|
372
|
+
- At least one alternative solution approach
|
|
373
|
+
- Why the main approach was chosen over alternatives
|
|
374
|
+
|
|
375
|
+
## Common Mistakes
|
|
376
|
+
- 3-5 specific mistakes learners make on this type of problem
|
|
377
|
+
- How to identify and fix each one
|
|
378
|
+
|
|
379
|
+
## Real-World Notes
|
|
380
|
+
- How this solution would differ in a production codebase
|
|
381
|
+
- Performance, security, or maintainability considerations
|
|
349
382
|
|
|
350
383
|
STEP 5 — Create topic-progress.md at:
|
|
351
384
|
{TOPICS_DIR}/{topic}/topic-progress.md
|
|
@@ -382,6 +415,8 @@ STEP 5 — Create topic-progress.md at:
|
|
|
382
415
|
- Do NOT use any external packages that aren't standard library without noting it
|
|
383
416
|
- Do NOT create assignments that are too easy (basic concept application) or too hard (leaps without foundation)
|
|
384
417
|
- Do NOT leave TODOs in scaffold that require making unrelated architectural decisions
|
|
418
|
+
- **Do NOT write solutions without researching first** — use google_search or context7 to verify API syntax, library behavior, and best practices before writing solution-guide.md
|
|
419
|
+
- **Do NOT guess** — if you're unsure how a library function works, look it up via context7. Guesses lead to inaccurate solutions.
|
|
385
420
|
|
|
386
421
|
6. CONTEXT:
|
|
387
422
|
- Skill: {skill}
|
|
@@ -654,17 +689,50 @@ task(category="unspecified-high", run_in_background=false, timeout=300000, promp
|
|
|
654
689
|
- TODO markers for user implementation
|
|
655
690
|
- All necessary imports/includes set up
|
|
656
691
|
|
|
657
|
-
d) solution-guide.md:
|
|
658
|
-
|
|
659
|
-
|
|
660
|
-
|
|
661
|
-
|
|
662
|
-
|
|
663
|
-
|
|
664
|
-
|
|
692
|
+
d) solution-guide.md — CRITICAL: Must be researched and accurate.
|
|
693
|
+
|
|
694
|
+
BEFORE writing:
|
|
695
|
+
1. Use google_search / context7_query-docs to research the correct approach.
|
|
696
|
+
2. Verify the solution works — test mentally or note assumptions.
|
|
697
|
+
3. Cross-reference with previous solution-guide.md files to maintain consistency.
|
|
698
|
+
|
|
699
|
+
Structure:
|
|
700
|
+
|
|
701
|
+
## Solution Overview
|
|
702
|
+
- Approach taken, key decisions, tradeoffs
|
|
703
|
+
|
|
704
|
+
## Complete Solution
|
|
705
|
+
```{language}
|
|
706
|
+
# Full working code with WHY comments, not just WHAT
|
|
707
|
+
```
|
|
708
|
+
|
|
709
|
+
## Step-by-Step Explanation
|
|
710
|
+
- Logical steps with reasoning for each
|
|
711
|
+
- What changes at this difficulty level vs previous assignments
|
|
712
|
+
|
|
713
|
+
## Edge Cases Handled
|
|
714
|
+
- What was considered and why
|
|
715
|
+
|
|
716
|
+
## Alternative Approaches
|
|
717
|
+
- Other valid solutions and when to use them
|
|
718
|
+
|
|
719
|
+
## Common Mistakes
|
|
720
|
+
- Specific errors learners make at this difficulty level
|
|
721
|
+
|
|
722
|
+
## Production Notes
|
|
723
|
+
- How this scales, performs, or differs in real codebases
|
|
724
|
+
|
|
725
|
+
5. MUST DO (research before generation):
|
|
726
|
+
- **Research FIRST** — Use context7 or google_search to verify your solution approach before writing
|
|
727
|
+
- **Cross-reference** with topic-explanation.md and prior solution-guide.md files
|
|
728
|
+
- **Verify accuracy** — If you're unsure about API syntax or behavior, look it up. Do not guess.
|
|
729
|
+
|
|
730
|
+
6. MUST NOT DO:
|
|
665
731
|
- Do NOT make the next assignment a repetition of the previous one
|
|
666
732
|
- Do NOT skip difficulty progression
|
|
733
|
+
- Do NOT write solutions without researching first
|
|
667
734
|
- Do NOT use external non-standard dependencies without noting it in scaffold setup
|
|
735
|
+
- Do NOT guess API signatures — use context7 to verify
|
|
668
736
|
|
|
669
737
|
6. CONTEXT:
|
|
670
738
|
- Skill: {skill}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "omnilearn-workflow",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.9",
|
|
4
4
|
"description": "OmniLearn — AI-powered adaptive learning workflow for OpenCode. Multi-agent orchestration that creates personalized roadmaps, hands-on assignments, and tracks progress across any skill.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"opencode",
|