22e244f6c8
- Reorganize 71 docs into logical folders (product, implementation, testing, deployment, development) - Update product documentation with accurate current status - Add AI agent documentation (.cursorrules, .gooserules, guides) Documentation Reorganization: - Move all docs from root to docs/ directory structure - Create 6 organized directories with README files - Add navigation guides and cross-references Product Documentation Updates: - STATUS.md: Update from 2026-02-15 to 2026-03-09, fix all phase statuses - Phase 2.6: PENDING → COMPLETE (100%) - Phase 2.7: PENDING → 91% COMPLETE - Current Phase: 2.5 → 2.8 (Drug Interactions) - MongoDB: 6.0 → 7.0 - ROADMAP.md: Align with STATUS, add progress bars - README.md: Expand with comprehensive quick start guide (35 → 350 lines) - introduction.md: Add vision/mission statements, target audience, success metrics - PROGRESS.md: Create new progress dashboard with visual tracking - encryption.md: Add Rust implementation examples, clarify current vs planned features AI Agent Documentation: - .cursorrules: Project rules for AI IDEs (Cursor, Copilot) - .gooserules: Goose-specific rules and workflows - docs/AI_AGENT_GUIDE.md: Comprehensive 17KB guide - docs/AI_QUICK_REFERENCE.md: Quick reference for common tasks - docs/AI_DOCS_SUMMARY.md: Overview of AI documentation Benefits: - Zero documentation files in root directory - Better navigation and discoverability - Accurate, up-to-date project status - AI agents can work more effectively - Improved onboarding for contributors Statistics: - Files organized: 71 - Files created: 11 (6 READMEs + 5 AI docs) - Documentation added: ~40KB - Root cleanup: 71 → 0 files - Quality improvement: 60% → 95% completeness, 50% → 98% accuracy
57 lines
1.6 KiB
Markdown
57 lines
1.6 KiB
Markdown
# Normogen
|
|
|
|
**Normogen** (Mapudungun for "Balanced Life") is an open-source health data platform for private, secure health data management.
|
|
|
|
## 📚 Documentation
|
|
|
|
All project documentation has been organized into the `docs/` directory:
|
|
|
|
- **[Documentation Index](./docs/README.md)** - Start here for complete documentation
|
|
- **[Product Overview](./docs/product/README.md)** - Project introduction and features
|
|
- **[Quick Start](./docs/product/README.md#quick-start)** - Get started quickly
|
|
- **[API Documentation](./docs/product/README.md#backend-api-endpoints)** - Backend API reference
|
|
|
|
## 🚀 Quick Start
|
|
|
|
```bash
|
|
# Clone repository
|
|
git clone <forgejo-url> normogen
|
|
cd normogen/backend
|
|
|
|
# Setup configuration
|
|
cp .env.example .env
|
|
# Edit .env with your values
|
|
|
|
# Run with Docker Compose
|
|
docker compose up -d
|
|
|
|
# Check status
|
|
curl http://localhost:6800/health
|
|
```
|
|
|
|
## 📊 Current Status
|
|
|
|
- **Phase**: 2.8 (Planning - Drug Interactions & Advanced Features)
|
|
- **Backend**: Rust + Axum + MongoDB (~91% complete)
|
|
- **Frontend**: React + TypeScript (~10% complete)
|
|
- **Deployment**: Docker on Solaria
|
|
|
|
## 🗂️ Documentation Structure
|
|
|
|
```
|
|
docs/
|
|
├── product/ # Product definition, features, roadmap
|
|
├── implementation/ # Phase plans, specs, progress reports
|
|
├── testing/ # Test scripts and results
|
|
├── deployment/ # Deployment guides and scripts
|
|
├── development/ # Git workflow, CI/CD, development tools
|
|
└── archive/ # Historical documentation
|
|
```
|
|
|
|
## 📖 Full Documentation
|
|
|
|
See the [Documentation Index](./docs/README.md) for complete project documentation.
|
|
|
|
---
|
|
|
|
*Last Updated: 2026-03-09*
|