Skip to content

Commit 23530c5

Browse files
committed
docs: update progress and feature guides
1 parent 5374120 commit 23530c5

File tree

10 files changed

+638
-774
lines changed

10 files changed

+638
-774
lines changed
File renamed without changes.
File renamed without changes.

docs/dev/feature-guides/themis/module-coherence-continuation.md

Lines changed: 633 additions & 0 deletions
Large diffs are not rendered by default.

docs/dev/roadmap/Metis-MVP.md

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,9 @@
1313
> This tasklist does not include upcoming [MVP Milestones](docs/dev/roadmap/Metis-MVP.md#2-mvp-milestones)
1414
1515
### 1.1. Open Tasks
16-
1716
#### 1.1.1. Due Tasks
1817

1918
#### 1.1.2. Other Tasks
20-
2119
- [ ] 1.1.2.1. Add boilerplate module text after generation
2220
- [ ] 1.1.2.2. Add different metadata changelog varieties to distinguish between initial AI creation, AI update of human creation, AI update or AI creation etc
2321
- [ ] 1.1.2.3. Ensure module generation adheres to tech stack requirements
@@ -38,13 +36,11 @@
3836
- 1.1.2.4.2. Should apply in both Metis and Metis-in-Themis
3937

4038
### 1.2. Blocked Tasks
41-
4239
<!-- No Blocked Tasks -->
4340

4441
---
4542

4643
## 2. MVP Milestones
47-
4844
- [ ] 2.1. Allow user to choose granularity/detail level of module generation
4945
- 2.1.1. For example, separate booleans at appropriate stage for project briefs, twists, research topics etc
5046
- 2.1.2. After generation pass complete, allow user to either progress with existing detail or fill in missing detail levels
@@ -62,7 +58,6 @@
6258
---
6359

6460
## 3. Beyond MVP: Future Features
65-
6661
- [ ] Comparison view (original vs. generated with diff)
6762
- [-] Update confidence scoring
6863
- [ ] Multiple generation variants
@@ -77,9 +72,7 @@
7772
---
7873

7974
## 4. Work Record
80-
8175
### 4.1. Completed Milestones
82-
8376
- 4.1.1. LangChain + Claude Integration
8477
- Create API route: `src/routes/api/generate/+server.ts`
8578
- LangChain's `ChatAnthropic` for Claude integration
@@ -144,11 +137,9 @@
144137
- **Why:** UX polish that makes the tool feel coherent.
145138

146139
### 4.2. Completed Tasks
147-
148140
#### 4.2.1. Record of Past Deadlines
149141

150142
#### 4.2.2. Record of Other Completed Tasks
151-
152143
- [x] 1.1.2.2. Display streaming response in UI via a scrolling/ephemeral window ✅ COMPLETED
153144
- SSE (Server-Sent Events) implementation with `progressMessages` array
154145
- Real-time streaming feedback in `.progress-log` component (src/routes/metis/update/+page.svelte:710-719)
@@ -164,15 +155,12 @@
164155
- Consistent visual pattern with Themis six-step workflow
165156

166157
##### 4.2.2.1. Metis Documentation
167-
168158
- [x] Add instructions for including an Anthropic API key in `README.md`
169159

170160
##### 4.2.2.2. Metis: Input Schema
171-
172161
- [x] Update input xml validator to allow attributes in root elements
173162

174163
##### 4.2.2.3. Metis: Prompt Template
175-
176164
- [x] Steer Claude towards better Twists
177165
- Added ProjectTwistGuidelines explaining twists as conceptual curveballs, not technical features
178166
- Included good examples: "The Helpful Saboteur", "The Unreliable Narrator", "The Contrarian", etc.
@@ -183,7 +171,6 @@
183171
- [x] Change xml output format to use self-closing tags & attributes
184172

185173
##### 4.2.2.4. Metis: Response, Output Schema & Export
186-
187174
- [x] Update schema files in to match `~/src/data/templates/outputSchema.xml`
188175
- Updated schemaTemplate.ts to include missing <Importance> field in AdditionalSkills section
189176
- Ensures schema consistency between template and outputSchema.xml

docs/dev/roadmap/Rhea-MVP.md

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,6 @@
2020
#### 1a1. Due Tasks
2121

2222
#### 1a2. Other Tasks
23-
2423
- [ ] 1a2a. Steer model towards British English in content generation
2524
- [ ] 1a2b. Add dark mode to UI
2625
- Should allow user to select light, dark or system
@@ -36,29 +35,27 @@
3635
- [ ] 1a2g. Research and implement different models for each separate LangChain AI call
3736
- [ ] 1a2h. Ensure components use the palette from their native workflow
3837
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.
38+
- [ ] 1a2i. Move module code from `/api/themis/module` to `/api/metis/*`
3939

4040
### 1b. Blocked Tasks
41+
<!-- No blocked tasks -->
4142

4243
---
4344

4445
## 2. MVP Milestones
45-
4646
- [ ] 2a. Implement Themis-style Theia previews for Metis (and Metis-in-Themis)
4747
- [ ] 2b. Address all ARIA violations
4848
- [ ] 2c. Update all Svelte legacy approaches and implementations to use Svelte 5
4949

5050
---
5151

5252
## 3. Beyond MVP: Future Features
53-
5453
- [ ] 3a. Allow defining custom research domains; this supports future generalisation of tool beyond AI engineering contexts
5554

5655
---
5756

5857
## 4. Work Record
59-
6058
### 4a. Completed Milestones
61-
6259
- [x] 4a1. Architectural Refactoring (2025-10-20) ✅ COMPLETED
6360
- **Branch:** `feat/new-course-generation`
6461
- **Commits:** `fea0d91` through `496d44f`
@@ -109,11 +106,9 @@
109106
- Reference: `src/lib/styles/palettes.css` (static documentation)
110107

111108
### 4b. Completed Tasks
112-
113109
#### 4b1. Record of Past Deadlines
114110

115111
#### 4b2. Record of Other Completed Tasks
116-
117112
- [x] 4b2a. Create an xml output sanitiser
118113
- Completed via xmlCleaner.ts and responseParser.ts
119114
- [x] 4b2b. Create colour palettes for Rhea, Themis, Tethys, Metis, and Theia based on their icons

docs/dev/roadmap/Tethys-MVP.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414
#### 1.1.2. Other Tasks
1515

1616
### 1.2. Blocked Tasks
17+
<!-- No blocked tasks -->
1718

1819
---
1920

docs/dev/roadmap/Thalassa-MVP.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@
1212
> This tasklist does not include upcoming [MVP Milestones](docs/dev/roadmap/Thalassa-MVP.md#2-mvp-milestones)
1313
1414
### 1.1. Open Tasks
15-
1615
#### 1.1.1. Due Tasks
1716

1817
#### 1.1.2. Other Tasks
@@ -30,11 +29,9 @@
3029
---
3130

3231
## 4. Work Record
33-
3432
### 4.1. Completed Milestones
3533

3634
### 4.2. Completed Tasks
37-
3835
#### 4.2.1. Record of Past Deadlines
3936

4037
#### 4.2.2. Record of Other Completed Tasks

docs/dev/roadmap/Theia-MVP.md

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,27 +9,23 @@
99
---
1010

1111
## 1. Tasks
12-
1312
> [!NOTE]
1413
> This tasklist does not include upcoming [MVP Milestones](docs/dev/roadmap/Theia-MVP.md#2-mvp-milestones)
1514
1615
### 1.1. Open Tasks
17-
1816
#### 1.1.1. Due Tasks
19-
2017
#### 1.1.2. Other Tasks
21-
2218
- [ ] 1.1.2.2. Add PDF export format (currently marked "coming soon" in UI)
2319
- [ ] 1.1.2.3. Add export analytics/usage tracking
2420
- [ ] 1.1.2.4. Implement Module XML upload & workflow resume functionality (see section 2.1.1)
2521
- Note: JSON course upload is complete; Module XML upload deferred to XML phase
2622

2723
### 1.2. Blocked Tasks
24+
<!-- No blocked tasks -->
2825

2926
---
3027

3128
## 2. MVP Milestones
32-
3329
- [ ] 2.1. JSON/XML Upload & Workflow Resume — IN PROGRESS
3430
- **Dependencies:** None for JSON upload (✅ complete), Themis course XML schema for XML upload
3531
- **Objective:** Enable users to upload previously generated files and either continue work in the original workflow or preview/export them standalone.
@@ -66,7 +62,6 @@
6662
---
6763

6864
## 3. Beyond MVP: Future Features
69-
7065
- [ ] 3.1. Export Formats
7166
- [ ] PDF generation with custom styling
7267
- [ ] JSON export for programmatic consumption
@@ -91,7 +86,6 @@
9186
## 4. Work Record
9287

9388
### 4.1. Completed Milestones
94-
9589
- [x] 4.1.1. Core Export Functionality ✅ COMPLETED (2025-10-23)
9690
**Branch:** `feat/theia`
9791
**PR:** #14
@@ -177,7 +171,6 @@
177171
#### 4.2.1. Record of Past Deadlines
178172

179173
#### 4.2.2. Record of Other Completed Tasks
180-
181174
- [x] 4.2.2.1. When file is uploaded, UI should navigate to correct step automatically ✅ COMPLETED
182175
- CourseStructureUpload.svelte (lines 123-127) dispatches `courseUploaded` event with course data
183176
- Parent component auto-redirects after successful JSON validation
@@ -193,7 +186,6 @@
193186
---
194187

195188
## 5. Success Criteria
196-
197189
- [ ] Users can upload valid module XML
198190
- [ ] Successful workflow continuation with pre-populated data
199191
- [ ] Validation errors are clear and actionable

docs/dev/roadmap/Themis-MVP.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,7 @@
6565
- [ ] 1.1.2.18. Allow multiple toggles to be open/closed without being affected by siblings
6666

6767
### 1.2. Blocked Tasks
68+
<!-- No blocked tasks -->
6869

6970
---
7071

0 commit comments

Comments
 (0)