alvaro/normogen
1
0
Fork 0
Code Issues 2 Pull requests Projects Releases Packages Wiki Activity Actions

docs: reconcile documentation with reality (P3)

Browse source 
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 2026-06-27 16:02:16 -03:00
parent bd1b7c2925
commit 17efc4f656
119 changed files with 469 additions and 17801 deletions
Download patch file Download diff file Expand all files Collapse all files

144
docs/README.md
View file

@ -1,97 +1,59 @@
### /home/asoliver/desarrollo/normogen/./docs/README.md
```markdown
1: # Normogen Documentation Index
2:
3: Welcome to the Normogen project documentation. This directory contains all project documentation organized by category.
4:
5: ## 📁 Documentation Structure
6:
7: ### [Product](./product/)
8: Core product documentation and project overview.
9: - **[README.md](./product/README.md)** - Project overview and quick start guide
10: - **[ROADMAP.md](./product/ROADMAP.md)** - Development roadmap and milestones
11: - **[STATUS.md](./product/STATUS.md)** - Current project status
12: - **[introduction.md](./product/introduction.md)** - Project introduction and background
13: - **[encryption.md](./product/encryption.md)** - Encryption and security architecture
14:
15: ### [Implementation](./implementation/)
16: Phase-by-phase implementation plans, specs, and progress reports.
17: - **Phase 2.3** - JWT Authentication completion reports
18: - **Phase 2.4** - User management enhancements
19: - **Phase 2.5** - Access control implementation
20: - **Phase 2.6** - Security hardening
21: - **Phase 2.7** - Health data features (medications, statistics)
22: - **Phase 2.8** - Drug interactions and advanced features
23: - **Frontend** - Frontend integration plans and progress
24:
25: ### [Testing](./testing/)
26: Test scripts, test results, and testing documentation.
27: - **[API_TEST_RESULTS_SOLARIA.md](./testing/API_TEST_RESULTS_SOLARIA.md)** - API test results
28: - **test-api-endpoints.sh** - API endpoint testing script
29: - **test-medication-api.sh** - Medication API tests
30: - **test-mvp-phase-2.7.sh** - Phase 2.7 comprehensive tests
31: - **solaria-test.sh** - Solaria deployment testing
32: - **quick-test.sh** - Quick smoke tests
33:
34: ### [Deployment](./deployment/)
35: Deployment guides, Docker configuration, and deployment scripts.
36: - **[DEPLOYMENT_GUIDE.md](./deployment/DEPLOYMENT_GUIDE.md)** - Complete deployment guide
37: - **[DEPLOY_README.md](./deployment/DEPLOY_README.md)** - Deployment quick reference
38: - **[QUICK_DEPLOYMENT_REFERENCE.md](./deployment/QUICK_DEPLOYMENT_REFERENCE.md)** - Quick deployment commands
39: - **[DOCKER_DEPLOYMENT_IMPROVEMENTS.md](./deployment/DOCKER_DEPLOYMENT_IMPROVEMENTS.md)** - Docker optimization notes
40: - **deploy-and-test.sh** - Deploy and test automation
41: - **deploy-to-solaria.sh** - Solaria deployment script
42:
43: ### [Development](./development/)
44: Development workflow, Git processes, and CI/CD documentation.
45: - **[COMMIT-INSTRUCTIONS.txt](./development/COMMIT-INSTRUCTIONS.txt)** - Commit message guidelines
46: - **[FORGEJO-CI-CD-PIPELINE.md](./development/FORGEJO-CI-CD-PIPELINE.md)** - CI/CD pipeline documentation
47: - **[FORGEJO-RUNNER-UPDATE.md](./development/FORGEJO-RUNNER-UPDATE.md)** - Runner update notes
48: - **[GIT-STATUS.md](./development/GIT-STATUS.md)** - Git workflow reference
49: - **COMMIT-NOW.sh** - Quick commit automation
50:
51: ### [Archive](./archive/)
52: Historical documentation and reference materials.
53:
54: ## 🔍 Quick Links
55:
56: ### For New Contributors
57: 1. Start with [Product README](./product/README.md)
58: 2. Review the [ROADMAP](./product/ROADMAP.md)
59: 3. Check [STATUS.md](./product/STATUS.md) for current progress
60:
61: ### For Developers
62: 1. Read [DEPLOYMENT_GUIDE.md](./deployment/DEPLOYMENT_GUIDE.md)
63: 2. Review [COMMIT-INSTRUCTIONS.txt](./development/COMMIT-INSTRUCTIONS.txt)
64: 3. Check [Implementation](./implementation/) docs for feature specs
65:
66: ### For Testing
67: 1. Run [quick-test.sh](./testing/quick-test.sh) for smoke tests
68: 2. Use [test-api-endpoints.sh](./testing/test-api-endpoints.sh) for API testing
69: 3. Review [API_TEST_RESULTS_SOLARIA.md](./testing/API_TEST_RESULTS_SOLARIA.md) for test history
70:
71: ## 📊 Project Status
72:
73: - **Current Phase**: Phase 2.8 (Planning)
74: - **Backend**: ~91% complete
75: - **Frontend**: ~10% complete
76: - **Last Updated**: 2026-03-09
77:
78: ---
79:
80: *Documentation last reorganized: 2026-03-09*
```
# 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
### Quick Reference
- **[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
### Getting Started
1. Read [AI_QUICK_REFERENCE.md](./AI_QUICK_REFERENCE.md) for essential commands
2. Review [AI_AGENT_GUIDE.md](./AI_AGENT_GUIDE.md) for detailed workflows
3. Check [product/STATUS.md](./product/STATUS.md) for current progress
4. Follow patterns in existing code