normogen/docs

/home/asoliver/desarrollo/normogen/./docs/README.md

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*

🤖 For AI Agents

Quick Reference

• AI Agent Quick Reference - Essential commands and patterns
• AI Agent Guide - Comprehensive guide for working in this repository

Getting Started

1. Read AI_QUICK_REFERENCE.md for essential commands
2. Review AI_AGENT_GUIDE.md for detailed workflows
3. Check product/STATUS.md for current progress
4. Follow patterns in existing code