Skip to content

Commit 6f5ece6

Browse files
JasonWarrenUKclaude
andcommitted
docs: update all documentation for Theia course upload feature
Updates user and developer documentation to reflect the completed Theia course structure upload implementation (PR #21). Changes emphasize Theia's new role as content manager, not just exporter, and highlight round-trip workflow capabilities. Documentation updates: - README.md: Reorder workflows (Theia first), expand features section, add Theia workflow steps with upload/export process - About-Rhea.md: Add "Recently Completed" section, update current state to reflect Theia capabilities - Technical-Overview.md: Rename Theia section to "Content Manager & Exporter", detail upload implementation components - docs/dev/status/README.md: Update Theia status with JSON upload features, add course upload to Recent Wins (#1 position) - docs/dev/status/Theia-MVP.md: Add completed milestone 4.1.2 for course upload, update milestone 2.1 status to IN PROGRESS - docs/dev/status/Rhea-MVP.md: Document Theia palette completion with magenta/cyan colour scheme All documentation now accurately represents: - Round-trip capability (export JSON → upload → continue) - Five workflow modules (Theia now functional, not planned) - JSON as the resumable format - Theia's dual role: content management + export 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
1 parent 0363410 commit 6f5ece6

File tree

6 files changed

+160
-61
lines changed

6 files changed

+160
-61
lines changed

README.md

Lines changed: 48 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,28 @@ An AI-powered curriculum generation tool for peer-led learning cohorts. Rhea use
66

77
## What Rhea Does
88

9-
Rhea contains three flows for generating curriculum materials
9+
Rhea contains five workflows for curriculum generation and management:
1010

11-
**Rhea** | **Themis** | **Tethys** | **Metis** | **Theia**
12-
:-------:|:----------:|:----------:|:---------:|:---------:
13-
![Rhea](static/icon.png) | ![Themis](static/themis/icon.png) | ![Tethys](static/tethys/icon.png) | ![Metis](static/metis/icon.png) | ![Theia](static/theia/icon.png)
11+
**Rhea** | **Theia** | **Themis** | **Tethys** | **Metis**
12+
:-------:|:---------:|:----------:|:----------:|:---------:
13+
![Rhea](static/icon.png) | ![Theia](static/theia/icon.png) | ![Themis](static/themis/icon.png) | ![Tethys](static/tethys/icon.png) | ![Metis](static/metis/icon.png)
1414

15-
<details><summary><strong>Metis:</strong> standalone module specifications</summary>
15+
<details><summary><strong>Theia:</strong> content management and export</summary>
1616
<ul>
17-
- Learning objectives and module overview
18-
- Detailed project briefs with examples and success criteria
19-
- Research topics with guidance for learners
20-
- Additional skills categorized by importance
21-
- Project "twists" to add interesting challenges
17+
- Upload previously generated course JSON files
18+
- Resume workflows from where you left off
19+
- Export to Markdown, HTML, or JSON formats
20+
- Configurable detail levels and section selection
21+
- Round-trip capability: export → upload → continue
22+
</ul>
23+
</details>
24+
25+
<details><summary><strong>Themis:</strong> complete multi-week courses</summary>
26+
<ul>
27+
- Thematic arcs organizing related modules
28+
- Learning progression across modules
29+
- Course-level narratives and structure
30+
- Individual module generation (coming soon)
2231
</ul>
2332
</details>
2433

@@ -30,12 +39,13 @@ Rhea contains three flows for generating curriculum materials
3039
</ul>
3140
</details>
3241

33-
<details><summary><strong>Themis:</strong> complete multi-week courses</summary>
42+
<details><summary><strong>Metis:</strong> standalone module specifications</summary>
3443
<ul>
35-
- Thematic arcs organizing related modules
36-
- Learning progression across modules
37-
- Course-level narratives and structure
38-
- Individual module generation (coming soon)
44+
- Learning objectives and module overview
45+
- Detailed project briefs with examples and success criteria
46+
- Research topics with guidance for learners
47+
- Additional skills categorized by importance
48+
- Project "twists" to add interesting challenges
3949
</ul>
4050
</details>
4151

@@ -120,24 +130,30 @@ Open **http://localhost:5173** to start using Rhea.
120130
- Automatic retry (up to 3 attempts) if validation fails
121131
</details>
122132

123-
<details><summary><strong>📤 Theia:</strong> Export & Preview</summary>
124-
Export generated content in human-readable formats:
125-
- **Multiple formats**: Markdown, HTML (PDF planned)
133+
<details><summary><strong>📤 Theia:</strong> Content Management & Export</summary>
134+
Manage previously generated content and export in human-readable formats:
135+
- **Upload & Resume**: Upload JSON course files to continue workflows in Themis
136+
- **Round-trip capability**: Export → upload → continue working seamlessly
137+
- **Multiple formats**: Markdown, HTML, JSON (PDF planned)
126138
- **Flexible detail levels**: Minimal, summary, detailed, or complete
127139
- **Selective exports**: Choose specific sections to export
128140
- **Course or module exports**: Works with both Metis and Themis outputs
129141
- **Table of contents**: Optional navigation for longer exports
142+
- **Drag-and-drop interface**: Easy file upload with validation
130143

131-
Export at any stage - preview course structures before module generation, or export individual modules after completion.
144+
Export at any stage, then re-upload to continue work later. Upload existing course structures to review, refine, or generate additional modules.
132145
</details>
133146

134147
### 🎨 Workflows
135148

136-
<details><summary><strong>Metis:</strong> Quick standalone modules</summary>
137-
1. Upload XML inputs (projects, skills, research)
138-
2. Provide structured context
139-
3. Generate with optional research
140-
4. Export preview or download XML specification
149+
<details><summary><strong>Theia:</strong> Manage and export content</summary>
150+
1. Upload previously generated course JSON files
151+
2. View uploaded course structure
152+
3. Choose action:
153+
- Continue in Themis to refine or generate modules
154+
- Export to human-readable formats (Markdown, HTML)
155+
4. Configure export settings (detail level, sections, format)
156+
5. Download formatted content
141157
</details>
142158

143159
<details><summary><strong>Themis:</strong> Complete multi-week courses</summary>
@@ -146,10 +162,17 @@ Open **http://localhost:5173** to start using Rhea.
146162
3. Organize modules within arcs
147163
4. AI generates detailed structure
148164
5. Review and refine
149-
6. Export course overview or structure
165+
6. Export course overview or structure (JSON for re-upload)
150166
7. Generate individual modules (coming soon)
151167
</details>
152168

169+
<details><summary><strong>Metis:</strong> Quick standalone modules</summary>
170+
1. Upload XML inputs (projects, skills, research)
171+
2. Provide structured context
172+
3. Generate with optional research
173+
4. Export preview or download XML specification
174+
</details>
175+
153176
---
154177

155178
## Documentation

docs/About-Rhea.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,9 +77,15 @@ Both workflows enforce rigour through structured inputs. No rambling chat – cl
7777
- **Tethys arc management**: Standalone arc creation and editing between course and module levels
7878
- **Diff views**: Side-by-side comparison for reviewing AI-proposed updates
7979
- **Provenance tracking UI**: Visual representation of change history and confidence levels
80-
- **Export/preview (Theia)**: Human-readable formats (Markdown, HTML, PDF) at various detail levels
80+
- **Module XML upload in Theia**: Currently supports JSON course upload; module XML upload planned for Q1 2026
8181

82-
The core intelligence is working. Research, generation, validation – all functional. The gap is workflow completeness and review tooling.
82+
**Recently Completed:**
83+
84+
- **Theia content management** (Oct 2025): Upload/resume workflows, JSON export, round-trip capability
85+
- **Themis arc-based structure** (Oct 2025): Six-step workflow with thematic organizational layer
86+
- **Architectural refactoring** (Oct 2025): Factories, utilities, centralized configurations
87+
88+
The core intelligence is working. Research, generation, validation – all functional. Theia provides content management and export. The gap is completing Themis module generation and review tooling.
8389

8490
## Why This Approach Is Actually Clever
8591

docs/dev/Technical-Overview.md

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -77,20 +77,32 @@ pedagogue/
7777
- Prompt: `src/lib/factories/prompts/themisPromptFactory.ts`
7878
- Components: `src/lib/components/themis/`
7979

80-
### Content Exporter (Theia)
80+
### Content Manager & Exporter (Theia)
8181

82-
**Purpose:** Export generated content in human-readable formats
82+
**Purpose:** Upload, manage, and export generated content
8383

8484
**Features:**
85-
- Export modules or courses at any generation stage
86-
- Multiple format support: Markdown, HTML (PDF planned)
87-
- Detail level control: minimal, summary, detailed, complete
88-
- Selective section exports
89-
- Automatic table of contents generation
85+
- **Upload & Resume:**
86+
- Upload JSON course files to continue Themis workflows
87+
- Comprehensive validation with clear error messages
88+
- Drag-and-drop interface with manual file selection
89+
- Auto-redirect to Themis on successful upload
90+
- **Export:**
91+
- Export modules or courses at any generation stage
92+
- Multiple formats: Markdown, HTML, JSON (PDF planned)
93+
- Detail level control: minimal, summary, detailed, complete
94+
- Selective section exports
95+
- Automatic table of contents generation
96+
- **Round-trip capability:** Export JSON → upload → continue working
9097

9198
**Implementation:**
99+
- Route: `src/routes/theia/+page.svelte`
92100
- Components: `src/lib/components/theia/`
101+
- `CourseStructureUpload.svelte` - Upload interface with validation
102+
- `ExportConfigModal.svelte` - Export configuration and preview
103+
- `ExportButton.svelte` - Export trigger with variants
93104
- Service: `src/lib/services/theiaService.ts`
105+
- Validation: `src/lib/utils/theia/courseValidator.ts`
94106
- Types: `src/lib/types/theia.ts`
95107
- Formatters: `src/lib/utils/theia/formatters/`
96108
- Content mapping: `src/lib/utils/theia/contentMapper.ts`

docs/dev/status/README.md

Lines changed: 24 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -7,17 +7,17 @@
77
## 1. Submodule Roadmaps
88

99
### 1.1. Core Modules
10-
- 1.1.1. [**Rhea:**](docs/dev/roadmaps/Rhea-MVP.md) _Platform_
10+
- 1.1.1. [**Rhea:**](Rhea-MVP.md) _Platform_
1111

1212
### 1.2. Workflow Modules
13-
- 1.2.1. [**Themis:**](docs/dev/roadmaps/Themis-MVP.md) _Course Builder_
14-
- 1.2.2. [**Tethys:**](docs/dev/roadmaps/Tethys-MVP.md) _Arc Designer_
15-
- 1.2.3. [**Metis:**](docs/dev/roadmaps/Metis-MVP.md) _Module Generator_
13+
- 1.2.1. [**Themis:**](Themis-MVP.md) _Course Builder_
14+
- 1.2.2. [**Tethys:**](Tethys-MVP.md) _Arc Designer_
15+
- 1.2.3. [**Metis:**](Metis-MVP.md) _Module Generator_
1616

1717
### 1.3. Utility Modules
18-
- 1.3.1. [**Theia:**](docs/dev/roadmaps/Theia-MVP.md) _Content Preview & Export_
19-
- 1.3.2. [**Atlas:**](docs/dev/roadmaps/Atlas-MVP.md) _Atomic Learning Assembler_
20-
- 1.3.3. [**Mnemosyne:**](docs/dev/roadmaps/Mnemosyne-MVP.md) _Storage & Retrieval_
18+
- 1.3.1. [**Theia:**](Theia-MVP.md) _Content Preview & Export_
19+
- 1.3.2. [**Atlas:**](Atlas-MVP.md) _Atomic Learning Assembler_
20+
- 1.3.3. [**Mnemosyne:**](Mnemosyne-MVP.md) _Storage & Retrieval_
2121

2222
---
2323

@@ -118,7 +118,7 @@
118118

119119
#### 2.3.1. Theia: Content Preview & Export
120120
<details><summary>Status: ~100% MVP ✅</summary>
121-
<p>Initial implementation complete and production-ready</p>
121+
<p>Core functionality complete and production-ready</p>
122122
</details>
123123

124124
<details><summary>Implemented</summary>
@@ -127,21 +127,26 @@
127127
<li>✅ Supports both Themis and Metis output</li>
128128
<li>✅ Configurable detail levels (minimal, summary, detailed, complete)</li>
129129
<li>✅ Selective export (specific arcs, modules, or sections)</li>
130-
<li>✅ Multiple formats (Markdown, HTML; PDF planned)</li>
130+
<li>✅ Multiple formats (Markdown, HTML, JSON; PDF planned)</li>
131131
<li>✅ Live preview before export</li>
132132
<li>✅ Client-side processing (no server storage)</li>
133133
<li>✅ Integrated into Metis and Themis workflows</li>
134+
<li>✅ <strong>NEW:</strong> Standalone <code>/theia</code> route with course upload interface</li>
135+
<li>✅ <strong>NEW:</strong> JSON course upload with drag-and-drop</li>
136+
<li>✅ <strong>NEW:</strong> Comprehensive validation for course structure</li>
137+
<li>✅ <strong>NEW:</strong> Round-trip workflow (Themis → export JSON → upload → continue)</li>
138+
<li>✅ <strong>NEW:</strong> Theia branding with magenta/cyan palette</li>
134139
</ul>
135-
<p>Implemented October 2025-10-23 via PR #14 (2,813 lines across 10 files)</p>
140+
<p>Initial export implementation: October 2025-10-23 via PR #14 (2,813 lines)</p>
141+
<p><strong>Course upload implementation: October 2025-10-24 via PR #21 (2,417 lines)</strong></p>
136142
</details>
137143

138144
<details><summary>Next Up</summary>
139-
<h5>XML Upload & Workflow Resume (Q1 2026)</h5>
145+
<h5>Module XML Upload & Workflow Resume (Q1 2026)</h5>
140146
<ul>
141-
<li>Standalone <code>/theia</code> route with upload interface</li>
142147
<li>Upload module XML → continue in Metis or preview/export</li>
143148
<li>Upload course XML → continue in Themis (after course XML schema exists)</li>
144-
<li>XML validation and error handling</li>
149+
<li>XML validation and type detection</li>
145150
</ul>
146151
<h5>Polish</h5>
147152
<ul>
@@ -202,9 +207,9 @@
202207
> [!NOTE]
203208
> 6 most recent achievements in this codebase
204209
205-
1. **[Theia: Content Preview & Export complete](Theia-MVP.md#21-core-export-functionality--completed-2025-10-23)** (2025-10-23) - Production-ready export system with Markdown/HTML formats, configurable detail levels, and selective section export (2,813 lines)
206-
2. **[Workflow colour palettes](Rhea-MVP.md#422-record-of-other-completed-tasks)** (2025-10-23) - Dynamic palette system with CSS custom properties for Rhea, Themis, Tethys, and Metis
207-
3. **[Themis arc-based structure complete](Themis-MVP.md#47-reimplement-the-module-overview-generation-based-on-thematic-arcs--completed)** - Six-step workflow with thematic organizational layer between courses and modules
208-
4. **[Architectural refactoring complete](Rhea-MVP.md#411-architectural-refactoring-2025-10-20--completed)** (2025-10-20) - 670+ lines eliminated via factories, utilities, and centralized configurations
209-
5. **[Themis `localStorage` persistence](Themis-MVP.md#48-add-localstorage-persistence--completed)** - Auto-save course progress via `persistedStore()` utility
210-
6. **[Centralized error handling infrastructure](Rhea-MVP.md#4114-quality-improvements)** - `ErrorBoundary` component, typed error classes, and error stores
210+
1. **[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 integrated across platform (2,417 lines)
211+
2. **[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)
212+
3. **[Workflow colour palettes complete](Rhea-MVP.md#422-record-of-other-completed-tasks)** (2025-10-23/24) - Dynamic palette system with CSS custom properties for all five workflows: Rhea, Themis, Tethys, Metis, and Theia
213+
4. **[Themis arc-based structure complete](Themis-MVP.md#47-reimplement-the-module-overview-generation-based-on-thematic-arcs--completed)** - Six-step workflow with thematic organizational layer between courses and modules
214+
5. **[Architectural refactoring complete](Rhea-MVP.md#411-architectural-refactoring-2025-10-20--completed)** (2025-10-20) - 670+ lines eliminated via factories, utilities, and centralized configurations
215+
6. **[Themis `localStorage` persistence](Themis-MVP.md#48-add-localstorage-persistence--completed)** - Auto-save course progress via `persistedStore()` utility

docs/dev/status/Rhea-MVP.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -56,9 +56,14 @@
5656
#### 4.2.2. Record of Other Completed Tasks
5757
- [x] Create an xml output sanitiser
5858
- Completed via xmlCleaner.ts and responseParser.ts
59-
- [x] Create colour palettes for Rhea, Themis, Tethys and Metis based on their icons
60-
- Completed via `src/lib/styles/palettes.css` (2025-10-23)
59+
- [x] Create colour palettes for Rhea, Themis, Tethys, Metis, and Theia based on their icons
60+
- Initial implementation: `src/lib/styles/palettes.css` (2025-10-23)
6161
- Branch: `ui/module-palettes` (merged via PR #15)
6262
- Implemented dynamic palette system with CSS custom properties
63-
- Palettes defined for all four modules: Rhea (default), Themis, Tethys, Metis
63+
- Palettes initially defined for four modules: Rhea (default), Themis, Tethys, Metis
6464
- Applied via `data-palette` attribute on root element
65+
- **Theia palette added:** (2025-10-24)
66+
- Branch: `theia/feat/continue-session-from-xml` (PR #21)
67+
- Magenta/cyan colour scheme (--palette-foreground: #B0127A, --palette-foreground-alt: #11B5C6)
68+
- Integrated in `paletteLoader.ts` and `paletteTypes.ts`
69+
- All five workflow palettes now complete

docs/dev/status/Theia-MVP.md

Lines changed: 53 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,21 +12,21 @@
1212
#### 1.1.2. Other Tasks
1313
- [ ] Add PDF export format (currently marked "coming soon" in UI)
1414
- [ ] Add export analytics/usage tracking
15-
- [ ] Implement XML upload & workflow resume functionality (see section 2)
15+
- [ ] Implement Module XML upload & workflow resume functionality (see section 2.1.1)
1616

1717
### 1.2. Blocked Tasks
1818

1919
---
2020

2121
## 2. MVP Milestones
2222

23-
### 2.1. XML Upload & Workflow Resume — PENDING
23+
### 2.1. JSON/XML Upload & Workflow Resume — IN PROGRESS
2424
**Target:** Q1 2026
2525
**Priority:** Medium
26-
**Dependencies:** Themis course XML schema (for Phase 2)
27-
**Objective:** Enable users to upload previously generated XML files and either continue work in the original workflow or preview/export them standalone.
26+
**Dependencies:** None for JSON upload (✅ complete), Themis course XML schema for XML upload
27+
**Objective:** Enable users to upload previously generated files and either continue work in the original workflow or preview/export them standalone.
2828

29-
#### 2.1.1. Module Upload (Immediate)
29+
#### 2.1.1. Module Upload (Deferred to XML Phase)
3030
**Components:**
3131
- `/theia` route with upload interface
3232
- File upload component (drag-drop + file picker)
@@ -104,6 +104,54 @@
104104

105105
## 4. Work Record
106106
### 4.1. Completed Milestones
107+
108+
#### 4.1.2. Course Structure Upload (JSON) ✅ COMPLETED (2025-10-24)
109+
**Branch:** `theia/feat/continue-session-from-xml`
110+
**PR:** #21
111+
**Commits:** `8e75209` through `0363410`
112+
113+
Implemented complete JSON course upload and validation system:
114+
115+
##### Components
116+
- `/theia` route - Main Theia page with course upload interface
117+
- `CourseStructureUpload.svelte` - Comprehensive upload component with:
118+
- Drag-and-drop file upload
119+
- Manual file selection
120+
- Real-time JSON validation
121+
- Clear error messaging
122+
- Auto-redirect to Themis on successful upload
123+
124+
##### Services & Utilities
125+
- `courseValidator.ts` (225 lines) - Zod-based validation for:
126+
- Complete course structure validation
127+
- Arc and module hierarchy validation
128+
- Logistics and learner data validation
129+
- Partial course support (for incomplete workflows)
130+
131+
##### Test Data
132+
- `partial-course.json` - Incomplete course for testing partial uploads
133+
- `valid-complete-course.json` - Full course structure for testing complete uploads
134+
135+
##### Integration
136+
- **JSON Export** - Added JSON format to `ExportConfigModal.svelte`
137+
- **Round-trip workflow** - Export from Themis → upload to Theia → continue in Themis
138+
- **Home page** - Theia workflow card added and promoted to primary position
139+
- **Theming** - Theia palette (magenta/cyan) integrated across platform
140+
141+
##### Key Features
142+
- ✅ JSON course file upload with validation
143+
- ✅ Drag-and-drop interface
144+
- ✅ Comprehensive error handling
145+
- ✅ Support for partial/incomplete courses
146+
- ✅ Auto-population of Themis store on success
147+
- ✅ Seamless workflow continuation
148+
- ✅ JSON export format for round-trip capability
149+
- ✅ Theia branding and palette integration
150+
151+
**Files Added:** 3 files (CourseStructureUpload.svelte, courseValidator.ts, test data)
152+
**Files Modified:** 18 files
153+
**Total Changes:** 2,417 insertions
154+
107155
#### 4.1.1. Core Export Functionality ✅ COMPLETED (2025-10-23)
108156
**Branch:** `feat/theia`
109157
**PR:** #14

0 commit comments

Comments
 (0)