docs/README.md

# Documentation Organization

This directory contains the documentation for the Cuatrolabs SCM Microservice, organized by topic.

## Structure

- **api-guides/**: Contains API reference guides, integration workflows, and endpoint documentation.
- **database/**: Contains database schema definitions, migration guides, SQL scripts, and migration tools.
    - `migrations/`: Python and SQL migration scripts.
    - `sql/`: Stored procedures and raw SQL files.
- **examples/**: Contains example scripts, data generation tools, test scripts, and usage examples.
- **implementation-summaries/**: Contains general implementation summaries, architectural overviews, and feature documentation.
- **security/**: Contains all JWT, authentication, and security-related documentation.
- **testing/**: Contains test results, reports, and testing documentation.

## Directory Contents Highlights

### API Guides
- `CATALOGUE_API_QUICK_REFERENCE.md`
- `EMPLOYEE_API_ENDPOINTS.md`
- `MERCHANT_KYC_WORKFLOW.md`

### Database
- `POSTGRES_DB.md`: Database schema documentation.
- `DATA_MIGRATION_SUMMARY.md`: Summary of data migration efforts.
- `SCHEMA_MIGRATION_SUMMARY.md`: Schema changes summary.
- `FOREIGN_KEY_FIXES_SUMMARY.md`: FK fixes documentation.

### Implementation Summaries
- `IMPLEMENTATION_SUMMARY.md`: End-to-end implementation summary.
- `INVENTORY_CONTROL_IMPLEMENTATION.md`
- `PRICING_LEVELS_COMPLETE_SOLUTION.md`
- `TRADE_SALES_IMPLEMENTATION.md`

### Examples
- Data generation scripts (`create_*.py`)
- Verification scripts (`verify_*.py`)
- Test scripts (`test_*.py`)
- Sample data (`*.json`)

### Security
- `ACCESS_ROLES_README.md`
- `API_STANDARDS.md`
- `AUTH_MIGRATION.md`

### Testing
- `MERCHANT_CATALOGUE_TEST_RESULTS.md`
- `PO_CREATION_TEST_REPORT.md`