03-Reference

Purpose: Technical reference documentation - API specs, database schemas, configuration details.

What Belongs Here

✅ Include: - API endpoint specifications - Database schema documentation - Configuration file references - Function/class reference documentation - Data models and structures - Environment variable lists - Technical specifications

❌ Don't Include: - How-to guides (use 04-Guides/ instead) - Architecture overviews (use 03-Architecture/ instead) - Implementation tutorials (use 04-Guides/ instead) - Design rationale (use 06-Decisions/ ADRs instead)

Directory Structure

05-Reference/
├── API/           # API endpoint specifications
│   ├── REST-API.md (WIP)
│   └── TheSportsDB-API.md (WIP)
├── Database/      # Database schemas and models
│   ├── Schema.md (WIP)
│   ├── Supabase-Setup.md (WIP)
│   ├── Credentials.md (WIP)
│   └── Migrations.md (WIP)
└── Configuration/ # Config file references (future)

Key Files

API/

REST-API.md: EPGOAT REST API endpoints (WIP)
TheSportsDB-API.md: TheSportsDB API integration reference (WIP)

Database/

Schema.md: Complete database schema (WIP)
Supabase-Setup.md: Supabase PostgreSQL database setup (WIP)
Credentials.md: Database credential management (WIP)
Migrations.md: Database migration procedures (WIP)

Writing Guidelines

Good reference docs should: 1. Be comprehensive: Cover all parameters, fields, options 2. Include types: Data types for all parameters 3. Show examples: Real-world usage examples 4. List constraints: Required fields, validation rules, limits 5. Link to guides: How-to guides that use this reference 6. Stay current: Update when implementation changes

When to Update

Update reference docs when: - Adding new API endpoints - Changing database schema - Modifying configuration options - Adding/removing function parameters - Changing data structures

Guides: See 04-Guides/ for how to use these references
Architecture: See 03-Architecture/ for system design
Standards: See 02-Standards/ for coding standards

Last Updated: 2025-11-05