VibecoderMcSwaggins commited on
Commit
bb240a6
Β·
1 Parent(s): f9f62d4

docs: Organize and archive implemented specs

Browse files

Archive implemented specs to docs/specs/archive/:
- SPEC_15: Advanced Mode Performance (PR #65) - max_rounds=5, early termination
- SPEC_16: Unified Chat Client Architecture (PR #115) - HuggingFace + OpenAI factory
- SPEC_17: Accumulator Pattern (PR #117) - Fixes repr bug

Active specs remaining:
- SPEC_13: Evidence Deduplication (draft)
- SPEC_14: ClinicalTrials Outcomes (draft)

Add README.md index for specs folder.

docs/specs/README.md ADDED
@@ -0,0 +1,67 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Implementation Specs
2
+
3
+ > Last updated: 2025-12-03
4
+ >
5
+ > **Note:** Implemented specs archived to `docs/specs/archive/`
6
+
7
+ ---
8
+
9
+ ## Active Specs (Not Yet Implemented)
10
+
11
+ ### SPEC_13: Evidence Deduplication
12
+
13
+ **File:** `SPEC_13_EVIDENCE_DEDUPLICATION.md`
14
+ **Status:** Draft - Ready for Implementation
15
+ **Priority:** P1
16
+ **GitHub Issue:** #94
17
+
18
+ **Problem:** Same paper appears 2-3 times because Europe PMC and OpenAlex both index PubMed.
19
+
20
+ **Solution:** Extract PMID from OpenAlex metadata, deduplicate by paper ID in SearchHandler.
21
+
22
+ ---
23
+
24
+ ### SPEC_14: ClinicalTrials Outcomes
25
+
26
+ **File:** `SPEC_14_CLINICALTRIALS_OUTCOMES.md`
27
+ **Status:** Draft - Ready for Implementation
28
+ **Priority:** P1
29
+ **GitHub Issue:** #95
30
+
31
+ **Problem:** ClinicalTrials tool misses critical efficacy data (primary outcomes, results availability).
32
+
33
+ **Solution:** Add `OutcomesModule` and `HasResults` to API fields, extract outcome measures.
34
+
35
+ ---
36
+
37
+ ## Implemented Specs (Archived)
38
+
39
+ All implemented specs are in `docs/specs/archive/`. Summary:
40
+
41
+ | Spec | Description | PR/Commit |
42
+ |------|-------------|-----------|
43
+ | SPEC_01 | Demo Termination | Archived |
44
+ | SPEC_02 | E2E Testing | Archived |
45
+ | SPEC_03 | OpenAlex Integration | Archived |
46
+ | SPEC_04 | Magentic UX | Archived |
47
+ | SPEC_05 | Orchestrator Cleanup | Archived |
48
+ | SPEC_06 | Simple Mode Synthesis | Archived (deleted simple.py) |
49
+ | SPEC_07 | LangGraph Memory Arch | Archived |
50
+ | SPEC_08 | Integrate Memory Layer | Archived |
51
+ | SPEC_09 | LlamaIndex Integration | Archived |
52
+ | SPEC_10 | Domain Agnostic Refactor | Archived |
53
+ | SPEC_11 | Sexual Health Focus | Archived |
54
+ | SPEC_12 | Narrative Synthesis | Archived |
55
+ | **SPEC_15** | Advanced Mode Performance | PR #65 - max_rounds=5, early termination |
56
+ | **SPEC_16** | Unified Chat Client Architecture | PR #115 - HuggingFace + OpenAI factory |
57
+ | **SPEC_17** | Accumulator Pattern | PR #117 - Fixes repr bug |
58
+
59
+ ---
60
+
61
+ ## How to Write a Spec
62
+
63
+ 1. Create `docs/specs/SPEC_{N}_{NAME}.md`
64
+ 2. Include: Problem, Solution, Test Plan, Acceptance Criteria
65
+ 3. Link to GitHub issue
66
+ 4. Update this README
67
+ 5. When implemented, move to `archive/`
docs/specs/{SPEC_15_ADVANCED_MODE_PERFORMANCE.md β†’ archive/SPEC_15_ADVANCED_MODE_PERFORMANCE.md} RENAMED
File without changes
docs/specs/{SPEC_16_UNIFIED_CHAT_CLIENT_ARCHITECTURE.md β†’ archive/SPEC_16_UNIFIED_CHAT_CLIENT_ARCHITECTURE.md} RENAMED
File without changes
docs/specs/{SPEC_17_ACCUMULATOR_PATTERN.md β†’ archive/SPEC_17_ACCUMULATOR_PATTERN.md} RENAMED
File without changes