docs

Documentation Index

Welcome to the Elzatona Web documentation! This directory contains all project documentation organized by area.

📚 Quick Links

Getting Started

• Main README - Project overview and quick start
• Local Development - Complete development guide
• Environment Setup - Environment configuration

API Documentation

• Website Swagger UI (local)
• Admin Swagger UI (local)
• Website OpenAPI JSON (local)
• Admin OpenAPI JSON (local)

Development Flows

• Local Development - Development workflow and commands
• Environment Setup - How to configure environments
• CI/CD Pipeline - Continuous integration and deployment
• Deployment - Deployment process and procedures

Project Structure

• Project Structure - Complete project structure and organization
• Website Application - Website-specific documentation
• Admin Application - Admin panel documentation
• Shared Libraries - Libraries documentation

Security & Quality

• Security Guide - Security best practices and pipeline
• Complete Security Pipeline - Detailed security setup
• Secret Rotation Guide - How to rotate secrets
• Secret Scanning Automation - Automated secret detection

Testing

• Testing Summary - Testing strategy overview
• Comprehensive Test Report - Detailed test results
• Test Summary - Test coverage summary

Database

• Database Schema - Database structure

Development Tools

• How to Get Supabase Keys - Supabase setup
• Setup Test Database - Test database configuration
• Git History Remediation - Clean up git history
• Security Fix Tools - Security tooling

Refactoring

• Refactoring Analysis - Code analysis and priorities
• Refactoring Progress - Refactoring status and strategy

📁 Directory Structure

docs/
├── flows/                  # Development flows
│   ├── local-development.md
│   ├── environment-setup.md
│   ├── ci-cd-pipeline.md
│   └── deployment.md
├── website/                # Website application docs
│   └── README.md
├── admin/                  # Admin application docs
│   └── README.md
├── libs/                   # Libraries documentation
│   └── README.md
├── database/              # Database documentation
│   └── questions-schema.md
└── [other docs]            # General documentation

🎯 Documentation by Role

For New Developers

1. Start with Main README
2. Read Local Development
3. Set up Environment
4. Review Project Structure

For DevOps/CI

1. CI/CD Pipeline
2. Deployment
3. Security Pipeline

For Security

1. Security Guide
2. Secret Rotation
3. Secret Scanning

For Testing

1. Testing Summary
2. Comprehensive Test Report

📝 Contributing to Documentation

When adding new documentation:

1. Place in appropriate directory:

   • flows/ - Development workflows
   • website/ - Website-specific
   • admin/ - Admin-specific
   • libs/ - Library-specific
   • Root docs/ - General documentation

2. Update this index if adding major documentation

3. Link from relevant README files

4. Follow existing format and structure