docs: reconcile documentation with reality (P3)
Make the project's documentation match the code and remove the sprawl. The docs
claimed Phase 2.8 (drug interactions) was 'planning/0%' and the backend '~91%
complete' — both wrong: 2.8 is implemented and live, plus the P0/P1 security
and test work is done. Five root CI/CD docs described a 'docker-build' CI job
that was removed; ~18 backend/ status snapshots and ~24 docs/implementation
duplicates cluttered the tree.
Deletions (85 files):
- Root: 4 stale CI/CD reports (CI-CD-{COMPLETION-REPORT,IMPLEMENTATION-SUMMARY,
STATUS-REPORT,FINAL-STATUS}.md) — all describe the removed docker-build job.
- backend/: 18 phase/build/fix snapshots and code-dump .txt files.
- docs/: the 3 one-time reorg reports; ~17 docs/implementation duplicates and
process artifacts; 4 stale docs/development CI docs + git snapshots;
redundant deployment/testing files.
- thoughts/: STATUS.md (said Phase 2.4 in-progress), superseded phase notes and
duplicative research inputs. tmp/ (928KB of CI debug logs, gitignored).
Moves (18 files):
- 9 genuine decision records -> docs/adr/ (Architecture Decision Records),
date-prefixes stripped, with an index README.
- 8 historical-but-valuable phase plans/specs + the old CI-CD-FINAL-SOLUTION ->
docs/archive/ (now-populated, with a README explaining it's superseded
material). thoughts/ tree removed.
Rewrites (13 files) to match reality:
- Drop the fake '% complete' figures everywhere in favor of Implemented /
In-Progress / Planned with concrete endpoint/feature lists.
- Phase 2.8 -> Implemented; add /api/interactions/* and /api/auth/{refresh,
logout} to the endpoint lists; fix 'Rust 1.93' -> edition 2021.
- Add a Security section (token_version validation, hashed refresh-token
persistence, fail-fast config, real-IP audit) and correct the test-coverage
and deployment claims to reality.
- New canonical docs/development/CI-CD.md (4 jobs: format/clippy/build/test,
mongo service, no docker-build + why).
- README, docs/README, product/{STATUS,ROADMAP,PROGRESS,README,introduction},
implementation/README, development/README, testing/README, AI_AGENT_GUIDE,
.cursorrules, .gooserules all updated.
Verified: greps for 'Phase 2.8 (Planning)', 'PLANNING (0%)', 'Rust 1.93',
'91%/10%/85% complete', and 'docker-build' return nothing outside docs/archive;
all internal doc links resolve; backend/src untouched (cargo build clean).
This commit is contained in:
goose
parent
bd1b7c2925
commit
17efc4f656
119 changed files with 469 additions and 17801 deletions
|
|
@ -1,107 +1,61 @@
|
|||
# Implementation Documentation
|
||||
|
||||
This section contains phase-by-phase implementation plans, specifications, progress reports, and completion summaries.
|
||||
Phase-by-phase implementation completion records. Each phase that's been built
|
||||
has a canonical completion note here; original plans and specs are in
|
||||
[../archive/](../archive/README.md).
|
||||
|
||||
## 📋 Organization
|
||||
## By Phase
|
||||
|
||||
### By Phase
|
||||
|
||||
#### Phase 2.3 - JWT Authentication ✅
|
||||
### Phase 2.3 — JWT Authentication ✅
|
||||
- [PHASE-2-3-COMPLETION-REPORT.md](./PHASE-2-3-COMPLETION-REPORT.md)
|
||||
- [PHASE-2-3-SUMMARY.md](./PHASE-2-3-SUMMARY.md)
|
||||
|
||||
#### Phase 2.4 - User Management ✅
|
||||
- [PHASE-2-4-COMPLETE.md](./PHASE-2-4-COMPLETE.md)
|
||||
### Phase 2.4 — User Management ✅
|
||||
- (completion notes folded into [../product/STATUS.md](../product/STATUS.md))
|
||||
|
||||
#### Phase 2.5 - Access Control ✅
|
||||
### Phase 2.5 — Access Control ✅
|
||||
- [PHASE-2-5-COMPLETE.md](./PHASE-2-5-COMPLETE.md)
|
||||
- [PHASE-2-5-FILES.txt](./PHASE-2-5-FILES.txt)
|
||||
- [PHASE-2-5-GIT-STATUS.md](./PHASE-2-5-GIT-STATUS.md)
|
||||
- [PHASE-2-5-STATUS.md](./PHASE-2-5-STATUS.md)
|
||||
|
||||
#### Phase 2.6 - Security Hardening ✅
|
||||
### Phase 2.6 — Security Hardening ✅
|
||||
- [PHASE_2.6_COMPLETION.md](./PHASE_2.6_COMPLETION.md)
|
||||
|
||||
#### Phase 2.7 - Health Data Features 🚧 (91% Complete)
|
||||
**Planning & Specs**
|
||||
- [PHASE_2.7_PLAN.md](./PHASE_2.7_PLAN.md) - Detailed implementation plan
|
||||
- [PHASE_2.7_MVP_PRIORITIZED_PLAN.md](./PHASE_2.7_MVP_PRIORITIZED_PLAN.md) - MVP features prioritized
|
||||
- [PHASE_2.7_DEPLOYMENT_PLAN.md](./PHASE_2.7_DEPLOYMENT_PLAN.md) - Deployment strategy
|
||||
### Phase 2.7 — Health Data Features ✅
|
||||
- [PHASE27_COMPLETION_REPORT.md](./PHASE27_COMPLETION_REPORT.md) - Completion report
|
||||
- [MVP_PHASE_2.7_SUMMARY.md](./MVP_PHASE_2.7_SUMMARY.md) - MVP prioritization
|
||||
- [MEDICATION_MANAGEMENT_IMPLEMENTATION_SUMMARY.md](./MEDICATION_MANAGEMENT_IMPLEMENTATION_SUMMARY.md) - Medication CRUD
|
||||
- Original plans: [../archive/](../archive/README.md)
|
||||
|
||||
**Progress & Status**
|
||||
- [PHASE_2.7_PROGRESS_SUMMARY.md](./PHASE_2.7_PROGRESS_SUMMARY.md) - Progress tracking
|
||||
- [PHASE27_STATUS.md](./PHASE27_STATUS.md) - Current status
|
||||
- [PHASE_2.7_CURRENT_STATUS.md](./PHASE_2.7_CURRENT_STATUS.md) - Status update
|
||||
- [MVP_PHASE_2.7_SUMMARY.md](./MVP_PHASE_2.7_SUMMARY.md) - MVP summary
|
||||
### Phase 2.8 — Drug Interactions ✅
|
||||
- [PHASE28_FINAL_STATUS.md](./PHASE28_FINAL_STATUS.md) - Completion (interactions live)
|
||||
- Original plan + specs: [../archive/](../archive/README.md)
|
||||
|
||||
**Medication Management**
|
||||
- [MEDICATION_IMPLEMENTATION_SUMMARY.md](./MEDICATION_IMPLEMENTATION_SUMMARY.md)
|
||||
- [MEDICATION_MANAGEMENT_COMPLETE.md](./MEDICATION_MANAGEMENT_COMPLETE.md)
|
||||
- [MEDICATION_MANAGEMENT_IMPLEMENTATION_SUMMARY.md](./MEDICATION_MANAGEMENT_IMPLEMENTATION_SUMMARY.md)
|
||||
- [MEDICATION_MANAGEMENT_STATUS.md](./MEDICATION_MANAGEMENT_STATUS.md)
|
||||
### Frontend 🚧
|
||||
- [FRONTEND_STATUS.md](./FRONTEND_STATUS.md) - Current frontend status
|
||||
|
||||
**Completion Reports**
|
||||
- [PHASE27_COMPLETION_REPORT.md](./PHASE27_COMPLETION_REPORT.md)
|
||||
- [PHASE27_FINAL_RESULTS.md](./PHASE27_FINAL_RESULTS.md)
|
||||
## Implementation Progress
|
||||
|
||||
**Fixes & Issues**
|
||||
- [PHASE_2.7_COMPILATION_FIX.md](./PHASE_2.7_COMPILATION_FIX.md)
|
||||
- [PHASE_2.7_COMPILATION_FIX_REPORT.md](./PHASE_2.7_COMPILATION_FIX_REPORT.md)
|
||||
- [PHASE_2.7_COMPILATION_STATUS.md](./PHASE_2.7_COMPILATION_STATUS.md)
|
||||
| Phase | Status |
|
||||
|-------|--------|
|
||||
| 2.3 | ✅ Implemented |
|
||||
| 2.4 | ✅ Implemented |
|
||||
| 2.5 | ✅ Implemented |
|
||||
| 2.6 | ✅ Implemented |
|
||||
| 2.7 | ✅ Implemented |
|
||||
| 2.8 | ✅ Implemented (drug interactions) |
|
||||
| P0/P1 Security + Tests | ✅ Implemented |
|
||||
| Frontend (Phase 3) | 🚧 Early |
|
||||
|
||||
#### Phase 2.8 - Drug Interactions & Advanced Features 📋 Planning
|
||||
**Specifications**
|
||||
- [PHASE28_PLAN.md](./PHASE28_PLAN.md) - Implementation plan
|
||||
- [PHASE28_COMPLETE_SPECS.md](./PHASE28_COMPLETE_SPECS.md) - Complete specifications
|
||||
- [PHASE28_COMPLETE_SPECS_V1.md](./PHASE28_COMPLETE_SPECS_V1.md) - Specifications v1
|
||||
- [PHASE28_PILL_IDENTIFICATION.md](./PHASE28_PILL_IDENTIFICATION.md) - Pill identification feature
|
||||
## Key Features Implemented
|
||||
|
||||
**Progress & Status**
|
||||
- [PHASE28_IMPLEMENTATION_SUMMARY.md](./PHASE28_IMPLEMENTATION_SUMMARY.md) - Implementation summary
|
||||
- [PHASE28_FINAL_STATUS.md](./PHASE28_FINAL_STATUS.md) - Final status
|
||||
- [PHASE28_REQUIREMENTS_CONFIRMED.md](./PHASE28_REQUIREMENTS_CONFIRMED.md) - Confirmed requirements
|
||||
- [PHASE28_READY_TO_START.md](./PHASE28_READY_TO_START.md) - Ready to start checklist
|
||||
|
||||
### Frontend Implementation
|
||||
- [FRONTEND_INTEGRATION_PLAN.md](./FRONTEND_INTEGRATION_PLAN.md) - Frontend integration strategy
|
||||
- [FRONTEND_PROGRESS_REPORT.md](./FRONTEND_PROGRESS_REPORT.md) - Frontend development progress
|
||||
- [FRONTEND_STATUS.md](./FRONTEND_STATUS.md) - Frontend current status
|
||||
|
||||
## 📊 Implementation Progress
|
||||
|
||||
| Phase | Status | Completion |
|
||||
|-------|--------|------------|
|
||||
| 2.3 | ✅ Complete | 100% |
|
||||
| 2.4 | ✅ Complete | 100% |
|
||||
| 2.5 | ✅ Complete | 100% |
|
||||
| 2.6 | ✅ Complete | 100% |
|
||||
| 2.7 | 🚧 In Progress | 91% |
|
||||
| 2.8 | 📋 Planned | 0% |
|
||||
| Frontend | 🚧 In Progress | 10% |
|
||||
|
||||
## 🎯 Key Features Implemented
|
||||
|
||||
### ✅ Completed
|
||||
- JWT Authentication with token rotation
|
||||
- User management (profiles, settings)
|
||||
- Permission-based access control
|
||||
- Share management system
|
||||
- Security hardening (rate limiting, audit logging)
|
||||
- Session management
|
||||
- Medication management
|
||||
- Health statistics tracking
|
||||
|
||||
### 🚧 In Progress
|
||||
- Medication adherence tracking
|
||||
- Lab results management
|
||||
|
||||
### 📋 Planned (Phase 2.8)
|
||||
- Drug interaction checking
|
||||
- Automated reminders
|
||||
- Advanced health analytics
|
||||
- Medication refill tracking
|
||||
- Caregiver access
|
||||
- JWT authentication with token rotation + `token_version` invalidation
|
||||
- User management (profiles, settings, password change/recovery)
|
||||
- Permission-based access control + share management
|
||||
- Security hardening (audit logging, account lockout, session management)
|
||||
- Medication management (CRUD, dose logging, adherence)
|
||||
- Health statistics tracking + trends
|
||||
- Drug interaction checking (OpenFDA-based ingredient mapping)
|
||||
- Refresh-token persistence (hashed, revocable) + `/refresh` and `/logout`
|
||||
- Fail-fast production config + real client-IP audit logging
|
||||
|
||||
---
|
||||
|
||||
*Last Updated: 2026-03-09*
|
||||
*Last Updated: 2026-06-27*
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue