Skip to content

Commit a6d4a24

Browse files
committed
docs: update roadmaps
1 parent 3c68bd8 commit a6d4a24

File tree

3 files changed

+62
-29
lines changed

3 files changed

+62
-29
lines changed

docs/dev/roadmap/README.md

Lines changed: 24 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -26,17 +26,21 @@
2626
> Following major architectural refactoring in October 2025-10, the codebase now features factories, utilities, and centralized configurations that enable rapid feature development.
2727
2828
### 2.1. Rhea: Core Platform
29-
<details><summary>Status: ~90% MVP</summary>
29+
<details><summary>Status: ~95% MVP</summary>
3030
<ul>
3131
<li>Foundation complete</li>
3232
<li>Component architecture established</li>
33-
<li>UI polish ongoing (dark mode, British English, emoji removal pending)</li>
33+
<li>✅ British English enforcement in AI generation</li>
34+
<li>✅ Emoji removed from UI and build scripts</li>
35+
<li>UI polish ongoing (dark mode pending)</li>
3436
</ul>
3537
</details>
3638

3739
<details><summary>Implemented</summary>
3840
<p>The platform provides a hub-based navigation structure with module-specific colour palettes and centralized error handling.</p>
3941
<p>Recent work focused on establishing reusable patterns for state management (<code>persistedStore()</code>), AI client configuration (agent factories), and prompt construction (composable prompt components).</p>
42+
<p>✅ <strong>British English enforcement</strong>: All AI-generated content now uses British spelling and terminology via <code>buildBritishEnglishInstructions()</code> integrated into all prompt factories.</p>
43+
<p>✅ <strong>Professional UI polish</strong>: Removed 54+ emoji instances from UI components and build scripts; improved accessibility and CI/CD compatibility.</p>
4044
</details>
4145

4246
<details><summary>Next Up</summary>
@@ -60,8 +64,11 @@
6064
<li>✅ Structure review interface with editable narratives</li>
6165
<li>✅ <code>localStorage</code> persistence for auto-save/restore</li>
6266
<li>✅ Module generation orchestration (ModuleGenerationList refactored: 896→441 lines)</li>
63-
<li>✅ <strong>NEW:</strong> Component breakdown (ProgressSummary, ModuleCard, ArcSection, ModulePreviewModal)</li>
64-
<li>✅ <strong>NEW:</strong> Centralized store utilities (moduleStoreHelpers.ts)</li>
67+
<li>✅ Component breakdown (ProgressSummary, ModuleCard, ArcSection, ModulePreviewModal)</li>
68+
<li>✅ Centralized store utilities (moduleStoreHelpers.ts)</li>
69+
<li>✅ <strong>NEW:</strong> Module coherence system with overview-first generation</li>
70+
<li>✅ <strong>NEW:</strong> Smart title system (undefined/prompt/literal modes)</li>
71+
<li>✅ <strong>NEW:</strong> Knowledge context builder for cumulative learner progression</li>
6572
<li>✅ Course-aware module generation API endpoint (193 lines)</li>
6673
<li>✅ Course context integration in prompt factory</li>
6774
<li>✅ CourseOverview component for final review and export (1462 lines)</li>
@@ -72,8 +79,7 @@
7279

7380
<details><summary>Next Up</summary>
7481
<ul>
75-
<li>Course XML schema validation</li>
76-
<li>Module-to-module coherence improvements (highest priority)</li>
82+
<li>Course XML schema validation (highest priority)</li>
7783
<li>Technical debt resolution (SSE, error handling)</li>
7884
<li>UI polish improvements</li>
7985
</ul>
@@ -205,22 +211,22 @@
205211
> [!NOTE]
206212
> The 5 most significant or important tasks to tackle next.
207213
208-
1. **[Radically improve module-to-module coherence](Themis-MVP.md#2-mvp-milestones)** (Themis 2.1) - Insert interstitial step for generating module overviews first, build learner knowledge context
209-
2. **[Add Course XML Schema and Validator](Themis-MVP.md#2-mvp-milestones)** (Themis 2.2) - Define course-level XML schema wrapping multiple modules
210-
3. **[Implement Export Functionality](Themis-MVP.md#2-mvp-milestones)** (Themis 2.3) - XML export for complete course (Theia integration)
211-
4. **[Add Dark Mode to UI](Rhea-MVP.md#112-other-tasks)** (Rhea 1.1.2.2) - User-selectable light/dark/system theme with dark palettes
212-
5. **[Implement Metis boilerplate text insertion](Metis-MVP.md)** - Add standard module text sections
214+
1. **[Add Course XML Schema and Validator](Themis-MVP.md#2-mvp-milestones)** (Themis 2.2) - Define course-level XML schema wrapping multiple modules with validation
215+
2. **[Implement XML Export Functionality](Themis-MVP.md#2-mvp-milestones)** (Themis 2.3) - Complete course XML export (depends on 2.2)
216+
3. **[Add Dark Mode to UI](Rhea-MVP.md#1a2-other-tasks)** (Rhea 1a2b) - User-selectable light/dark/system theme with dark palettes for all workflows
217+
4. **[Implement Metis boilerplate text insertion](Metis-MVP.md)** - Add standard module text sections for consistent structure
218+
5. **[Address ARIA violations](Rhea-MVP.md#2-mvp-milestones)** (Rhea 2b) - Improve accessibility across all workflow components
213219

214220
---
215221

216222
## 4. Recent Wins
217223
> [!NOTE]
218224
> 7 most recent achievements in this codebase
219225
220-
1. **[British English & Emoji Cleanup](Rhea-MVP.md#4a3-british-english--emoji-cleanup--completed-2025-10-28)** (2025-10-28) - Added British English instructions to all prompt factories (Metis standalone, course-aware, overview; Themis structure). Removed emoji from build scripts. All AI-generated content now uses British spelling/terminology consistently (49 lines changed, zero breaking changes).
221-
2. **[Roadmap Maintenance & Technical Debt Documentation](README.md)** (2025-10-28) - Updated all active roadmaps with current task status, moved completed items to work record (timeout extraction, UI improvements, component organization), documented remaining technical debt in Themis (SSE parsing vulnerability, race conditions, error handling gaps)
222-
3. **[Themis: Component Refactoring Complete](Themis-MVP.md#411-break-over-large-themis-components-into-subcomponents--completed-2025-10-27)** (2025-10-27) - Split 896-line ModuleGenerationList into focused components (ProgressSummary, ModuleCard, ArcSection, ModulePreviewModal) and centralized store utilities. Main component reduced 51%, improved maintainability and testability.
223-
4. **[Themis: Complete Module Generation Workflow](Themis-MVP.md#410-complete-module-generation-workflow-steps-5-6--completed-2025-10-25)** (2025-10-25) - End-to-end course generation complete: ModuleGenerationList (897 lines), course-aware API endpoint (193 lines), CourseOverview (1462 lines), SSE streaming, and Theia export integration
224-
5. **[Rhea: Palette System Overhaul](Rhea-MVP.md#21-overhaul-palette-system--completed-2025-10-25)** (2025-10-25) - Complete refactor establishing single source of truth at `src/lib/config/palettes/`, build-time CSS generation, 56 files converted, 2,817 insertions
225-
6. **[Theia: Course Structure Upload (JSON)](Theia-MVP.md#412-course-structure-upload-json--completed-2025-10-24)** (2025-10-24) - Complete JSON upload workflow with validation, drag-and-drop interface, and round-trip capability (Themis → export → upload → continue). Theia branding with magenta/cyan palette (2,417 lines)
226-
7. **[Theia: Content Preview & Export complete](Theia-MVP.md#411-core-export-functionality--completed-2025-10-23)** (2025-10-23) - Production-ready export system with Markdown/HTML/JSON formats, configurable detail levels, and selective section export (2,813 lines)
226+
1. **[Themis: Module Coherence with Overview-First Generation](Themis-MVP.md#412-radically-improve-module-to-module-coherence--completed-2025-10-2728)** (2025-10-27/28) - Implemented two-phase workflow: smart title system (undefined/prompt/literal modes) and lightweight module overviews before full generation. Knowledge context builder tracks learner progression cumulatively, reducing content repetition. Review 10 overviews in ~5min vs 10 full modules in ~20min. 1,479 insertions across 21 files (PR #27).
227+
2. **[British English & Emoji Cleanup](Rhea-MVP.md#4a3-british-english--emoji-cleanup--completed-2025-10-28)** (2025-10-28) - Added British English instructions to all prompt factories (Metis standalone, course-aware, overview; Themis structure). Removed emoji from build scripts. All AI-generated content now uses British spelling/terminology consistently (49 lines changed, zero breaking changes).
228+
3. **[Roadmap Maintenance & Technical Debt Documentation](README.md)** (2025-10-28) - Updated all active roadmaps with current task status, moved completed items to work record (timeout extraction, UI improvements, component organization), documented remaining technical debt in Themis (SSE parsing vulnerability, race conditions, error handling gaps)
229+
4. **[Themis: Component Refactoring Complete](Themis-MVP.md#411-break-over-large-themis-components-into-subcomponents--completed-2025-10-27)** (2025-10-27) - Split 896-line ModuleGenerationList into focused components (ProgressSummary, ModuleCard, ArcSection, ModulePreviewModal) and centralized store utilities. Main component reduced 51%, improved maintainability and testability.
230+
5. **[Themis: Complete Module Generation Workflow](Themis-MVP.md#4111-complete-module-generation-workflow-steps-5-6--completed-2025-10-25)** (2025-10-25) - End-to-end course generation complete: ModuleGenerationList (897 lines), course-aware API endpoint (193 lines), CourseOverview (1462 lines), SSE streaming, and Theia export integration
231+
6. **[Rhea: Palette System Overhaul](Rhea-MVP.md#4a2-overhaul-palette-system--completed-2025-10-25)** (2025-10-25) - Complete refactor establishing single source of truth at `src/lib/config/palettes/`, build-time CSS generation, 56 files converted, 2,817 insertions
232+
7. **[Theia: Course Structure Upload (JSON)](Theia-MVP.md#412-course-structure-upload-json--completed-2025-10-24)** (2025-10-24) - Complete JSON upload workflow with validation, drag-and-drop interface, and round-trip capability (Themis → export → upload → continue). Theia branding with magenta/cyan palette (2,417 lines)

docs/dev/roadmap/Rhea-MVP.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,9 @@
3333
- [ ] 1a2h. Ensure components use the palette from their native workflow
3434
Regardless of current route, module generation is part of Metis; using a `/themis` route should show themis' palette, but individual modules that display within the page should have metis' palette applied. Eventually this will apply Tethys to arcs in themis as well.
3535
- [ ] 1a2i. Move module code from `/api/themis/module` to `/api/metis/*`
36+
- [ ] 1a2j. Implement test data generation with British English enforcement
37+
- Verify that generated modules now use British spelling
38+
- Test with both Metis and Themis workflows
3639

3740
### 1b. Blocked Tasks
3841
<!-- No blocked tasks -->
@@ -111,13 +114,14 @@
111114
- **Impact:**
112115
- All AI-generated content now uses British English consistently
113116
- More professional console output for CI/CD environments
114-
- 49 total lines changed across 4 files
117+
- 54+ emoji instances removed from UI components
118+
- 49 total lines changed across 4 files (British English)
119+
- ~757 lines changed across 20 files (emoji removal)
115120
- Zero breaking changes to existing APIs
116121
- **Architecture:**
117-
- Single source: `src/lib/config/palettes/{workflow}Palette.ts`
118-
- Transformation: `src/lib/utils/palette/paletteTransformer.ts`
119-
- Application: `src/routes/+layout.svelte` (via data-palette attribute)
120-
- Reference: `src/lib/styles/palettes.css` (static documentation)
122+
- Shared component: `src/lib/utils/prompt/shared-components.ts` (British English instructions)
123+
- Integration: `src/lib/factories/prompts/{metis,themis}PromptFactory.ts`
124+
- Scope: All AI-generated content (objectives, topics, narratives, project briefs)
121125

122126
### 4b. Completed Tasks
123127
#### 4b1. Record of Past Deadlines

docs/dev/roadmap/Themis-MVP.md

Lines changed: 29 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -75,11 +75,6 @@
7575

7676
## 2. MVP Milestones
7777

78-
- [ ] 2.1. Radically improve module-to-module coherence at generation
79-
- 2.1.1. **IMPORTANT:** confer with user to understand requirements
80-
- 2.1.2. Insert interstitial step: generating module overviews first, allowing later generation of full module spec
81-
- 2.1.3. Cumulatively build a reference snipped on what learners will already know by the time a module starts, then pass that snippet to Metis
82-
- 2.1.4. Separate all prompt snippets into separate files for increased visibility to devs
8378
- [ ] 2.2. Add Course XML Schema and Validator 📋 PENDING
8479
- Define course-level XML schema wrapping multiple modules
8580
- Validation for complete course structure
@@ -127,7 +122,35 @@
127122
- Improved maintainability and testability
128123
- Better component composition and reusability
129124
- **Why completed:** Addresses roadmap tasks 1.1.2.6 and 1.1.2.7, establishing foundation for future improvements
130-
- [x] 4.1.2. Create Hub Dashboard and Navigation Structure ✅ COMPLETED
125+
- [x] 4.1.2. Radically Improve Module-to-Module Coherence ✅ COMPLETED (2025-10-27/28)
126+
- **Branch:** `themis/feat/module-coherence`
127+
- **PR:** #27 (merged 2025-10-28)
128+
- **Commits:** `fcea57c` through `5847ee2` (7 commits)
129+
- **Documentation:** `/docs/dev/feature-guides/themis/module-coherence-continuation.md`
130+
- **Summary:** Two-phase implementation adding smart title system and overview-first generation workflow
131+
- **Phase 1 - Foundation:**
132+
- TitleInput type system (undefined/prompt/literal modes) - `src/lib/types/themis.ts`
133+
- TitleInputField component (113 lines) - `src/lib/components/themis/TitleInputField.svelte`
134+
- Migration utilities for backward compatibility - `src/lib/utils/themis/migrations.ts` (109 lines)
135+
- ModuleOverview interface and validation
136+
- **Phase 2 - Overview Generation:**
137+
- Module overview API endpoint - `src/routes/api/themis/module/overview/+server.ts` (201 lines)
138+
- Knowledge context builder - `src/lib/utils/themis/knowledgeContextBuilder.ts` (241 lines)
139+
- Overview prompt factory - `src/lib/factories/prompts/metisPromptFactory.ts` (buildModuleOverviewPrompt)
140+
- Two-step workflow UI in ModuleGenerationList
141+
- 'overview-ready' status tracking
142+
- **Key Features:**
143+
- Smart titles: AI can decide, be guided, or use exact titles
144+
- Lightweight overviews: ~30s generation, 1/3 cost of full module
145+
- Knowledge context: Cumulative tracking of learner progress
146+
- Reduced repetition: Each module knows what came before
147+
- Faster iteration: Review 10 overviews in ~5min vs 10 full modules in ~20min
148+
- **Impact:**
149+
- 1,479 insertions, 238 deletions across 21 code files
150+
- Addresses MVP milestone 2.1 completely
151+
- Foundation for improved course coherence and quality
152+
- **Why completed:** Solves the critical problem of module content repetition by providing rich context about learner knowledge progression
153+
- [x] 4.1.3. Create Hub Dashboard and Navigation Structure ✅ COMPLETED
131154
- Created hub dashboard at `/` with cards for "Generate Module" and "Generate Course"
132155
- Moved existing module generator to `/module/new`
133156
- Added breadcrumb navigation in layout for all routes

0 commit comments

Comments
 (0)