# Bakery IA - Documentation Index

Welcome to the Bakery IA documentation! This guide will help you navigate through all aspects of the project, from getting started to advanced operations.

## Quick Links

- **New to the project?** Start with [Getting Started](01-getting-started/README.md)
- **Need to understand the system?** See [Architecture Overview](02-architecture/system-overview.md)
- **Looking for APIs?** Check [API Reference](08-api-reference/README.md)
- **Deploying to production?** Read [Deployment Guide](05-deployment/README.md)
- **Having issues?** Visit [Troubleshooting](09-operations/troubleshooting.md)

## Documentation Structure

### 📚 [01. Getting Started](01-getting-started/)
Start here if you're new to the project.
- [Quick Start Guide](01-getting-started/README.md) - Get up and running quickly
- [Installation](01-getting-started/installation.md) - Detailed installation instructions
- [Development Setup](01-getting-started/development-setup.md) - Configure your dev environment

### 🏗️ [02. Architecture](02-architecture/)
Understand the system design and components.
- [System Overview](02-architecture/system-overview.md) - High-level architecture
- [Microservices](02-architecture/microservices.md) - Service architecture details
- [Data Flow](02-architecture/data-flow.md) - How data moves through the system
- [AI/ML Components](02-architecture/ai-ml-components.md) - Machine learning architecture

### ⚡ [03. Features](03-features/)
Detailed documentation for each major feature.

#### AI & Analytics
- [AI Insights Platform](03-features/ai-insights/overview.md) - ML-powered insights
- [Dynamic Rules Engine](03-features/ai-insights/dynamic-rules-engine.md) - Pattern detection and rules

#### Tenant Management
- [Deletion System](03-features/tenant-management/deletion-system.md) - Complete tenant deletion
- [Multi-Tenancy](03-features/tenant-management/multi-tenancy.md) - Tenant isolation and management
- [Roles & Permissions](03-features/tenant-management/roles-permissions.md) - RBAC system

#### Other Features
- [Orchestration System](03-features/orchestration/orchestration-refactoring.md) - Workflow orchestration
- [Sustainability Features](03-features/sustainability/sustainability-features.md) - Environmental tracking
- [Hyperlocal Calendar](03-features/calendar/hyperlocal-calendar.md) - Event management

### 💻 [04. Development](04-development/)
Tools and workflows for developers.
- [Development Workflow](04-development/README.md) - Daily development practices
- [Tilt vs Skaffold](04-development/tilt-vs-skaffold.md) - Development tool comparison
- [Testing Guide](04-development/testing-guide.md) - Testing strategies and best practices
- [Debugging](04-development/debugging.md) - Troubleshooting during development

### 🚀 [05. Deployment](05-deployment/)
Deploy and configure the system.
- [Kubernetes Setup](05-deployment/README.md) - K8s deployment guide
- [Security Configuration](05-deployment/security-configuration.md) - Security setup
- [Database Setup](05-deployment/database-setup.md) - Database configuration
- [Monitoring](05-deployment/monitoring.md) - Observability setup

### 🔒 [06. Security](06-security/)
Security implementation and best practices.
- [Security Overview](06-security/README.md) - Security architecture
- [Database Security](06-security/database-security.md) - DB security configuration
- [RBAC Implementation](06-security/rbac-implementation.md) - Role-based access control
- [TLS Configuration](06-security/tls-configuration.md) - Transport security
- [Security Checklist](06-security/security-checklist.md) - Pre-deployment checklist

### ⚖️ [07. Compliance](07-compliance/)
Data privacy and regulatory compliance.
- [GDPR Implementation](07-compliance/gdpr.md) - GDPR compliance
- [Data Privacy](07-compliance/data-privacy.md) - Privacy controls
- [Audit Logging](07-compliance/audit-logging.md) - Audit trail system

### 📖 [08. API Reference](08-api-reference/)
API documentation and integration guides.
- [API Overview](08-api-reference/README.md) - API introduction
- [AI Insights API](08-api-reference/ai-insights-api.md) - AI endpoints
- [Authentication](08-api-reference/authentication.md) - Auth mechanisms
- [Tenant API](08-api-reference/tenant-api.md) - Tenant management endpoints

### 🔧 [09. Operations](09-operations/)
Production operations and maintenance.
- [Operations Guide](09-operations/README.md) - Ops overview
- [Monitoring & Observability](09-operations/monitoring-observability.md) - System monitoring
- [Backup & Recovery](09-operations/backup-recovery.md) - Data backup procedures
- [Troubleshooting](09-operations/troubleshooting.md) - Common issues and solutions
- [Runbooks](09-operations/runbooks/) - Step-by-step operational procedures

### 📋 [10. Reference](10-reference/)
Additional reference materials.
- [Changelog](10-reference/changelog.md) - Project history and milestones
- [Service Tokens](10-reference/service-tokens.md) - Token configuration
- [Glossary](10-reference/glossary.md) - Terms and definitions
- [Smart Procurement](10-reference/smart-procurement.md) - Procurement feature details

## Additional Resources

- **Main README**: [Project README](../README.md) - Project overview and quick start
- **Archived Docs**: [Archive](archive/) - Historical documentation and progress reports

## Contributing to Documentation

When updating documentation:
1. Keep content focused and concise
2. Use clear headings and structure
3. Include code examples where relevant
4. Update this index when adding new documents
5. Cross-link related documents

## Documentation Standards

- Use Markdown format
- Include a clear title and introduction
- Add a table of contents for long documents
- Use code blocks with language tags
- Keep line length reasonable for readability
- Update the last modified date at the bottom

---

**Last Updated**: 2025-11-04
