# 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