17efc4f656
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).
59 lines
2.5 KiB
Markdown
59 lines
2.5 KiB
Markdown
# Normogen Documentation Index
|
|
|
|
Welcome to the Normogen project documentation. This directory contains all
|
|
project documentation organized by category.
|
|
|
|
## 📁 Documentation Structure
|
|
|
|
### [Product](./product/)
|
|
Core product documentation and project overview.
|
|
- **[README.md](./product/README.md)** - Project overview and quick start guide
|
|
- **[STATUS.md](./product/STATUS.md)** - Current project status
|
|
- **[ROADMAP.md](./product/ROADMAP.md)** - Development roadmap and milestones
|
|
- **[PROGRESS.md](./product/PROGRESS.md)** - Progress dashboard
|
|
- **[introduction.md](./product/introduction.md)** - Project introduction and background
|
|
- **[encryption.md](./product/encryption.md)** - Encryption and security architecture
|
|
|
|
### [Implementation](./implementation/)
|
|
Phase-by-phase implementation completion records (2.3 through 2.8, plus frontend).
|
|
See [implementation/README.md](./implementation/README.md) for the full list.
|
|
|
|
### [ADR](./adr/)
|
|
Architecture Decision Records — the "why" behind the major technical choices
|
|
(stack, schema, JWT, frontend, deployment).
|
|
|
|
### [Development](./development/)
|
|
Development workflow and CI/CD.
|
|
- **[CI-CD.md](./development/CI-CD.md)** - The Forgejo CI/CD pipeline (current)
|
|
- **[README.md](./development/README.md)** - Workflow and conventions
|
|
|
|
### [Testing](./testing/)
|
|
Test scripts and testing notes.
|
|
- **test-api-endpoints.sh** - API endpoint testing
|
|
- **test-medication-api.sh** - Medication API tests
|
|
- **solaria-test.sh** / **check-solaria-logs.sh** - Solaria deployment testing
|
|
- **quick-test.sh** - Quick smoke test
|
|
|
|
### [Deployment](./deployment/)
|
|
Deployment guides and scripts.
|
|
- **[DEPLOYMENT_GUIDE.md](./deployment/DEPLOYMENT_GUIDE.md)** - Complete deployment guide
|
|
- **deploy-to-solaria.sh** / **deploy-and-test-solaria.sh** - Solaria deployment scripts
|
|
|
|
### [Archive](./archive/)
|
|
Superseded and historical documentation kept for reference (phase plans, old CI
|
|
state, point-in-time test snapshots). Not current.
|
|
|
|
## 📊 Project Status
|
|
|
|
- **Backend**: Phase 2.x feature-complete (through drug interactions); security-hardened; deployed on Solaria.
|
|
- **Frontend**: Early stage (Login/Register + API/store layer; router not wired).
|
|
- **Tests**: 18 unit + 13 integration, CI-gated with MongoDB.
|
|
- See [product/STATUS.md](./product/STATUS.md) for the full breakdown.
|
|
- **Last Updated**: 2026-06-27
|
|
|
|
---
|
|
|
|
## 🤖 For AI Agents
|
|
|
|
- **[AI Agent Quick Reference](./AI_QUICK_REFERENCE.md)** - Essential commands and patterns
|
|
- **[AI Agent Guide](./AI_AGENT_GUIDE.md)** - Comprehensive guide for working in this repository
|