PiqueTickets Documentation¶

Welcome to the PiqueTickets documentation hub. This directory contains comprehensive documentation for the entire PiqueTickets system.

📚 Documentation Structure¶

🏗️ Architecture ¶

System architecture, design decisions, and technical overviews.

Database Schema - Complete database structure and relationships
Checkout Queue Architecture - Queue-based checkout system design
Multi-Environment Deployment - Cloudflare multi-environment setup

📖 Guides ¶

How-to guides, configuration instructions, and operational procedures.

API Guides¶

Password Reset API - Password reset endpoint documentation
Celery Beat Setup - Setting up and testing Celery Beat
Quick Testing Guide - Quick commands for testing API components

Frontend Guides¶

Cache Management - Next.js cache configuration and management
CDN Caching - CDN and edge caching implementation

Producer Portal Guides¶

Authentication Configuration - Auth token settings and configuration
Knowledge Base Implementation - Knowledge base feature guide

⚙️ Operations ¶

Deployment, monitoring, and maintenance documentation.

Cloudflare Deployment - Multi-environment Cloudflare deployment
Database Monitoring - Production database connection monitoring
Database Connection Management - Managing database connections

🧪 Testing ¶

Test plans, testing strategies, and QA documentation.

E2E Testing Strategy - End-to-end testing approach with Playwright
Load Testing - Load testing plan for the Django API
Checkout Testing - Checkout workflow testing plan
API Testing Guide - API testing strategies and fixes

📋 Planning ¶

Active feature plans, proposals, and design documents.

Feature Flags Integration - Feature flag system implementation
Knowledge Base Feature - Producer portal knowledge base planning
Performance Optimization - System performance improvements

📦 Archive ¶

Historical documents, completed plans, and deprecated documentation.

See Archive README for details on archived documentation.

📝 Templates ¶

Documentation templates for creating new documents.

Feature Plan Template - Template for feature planning documents
Architecture Document Template - Template for architecture documentation
Testing Plan Template - Template for test plans

🔍 Finding Documentation¶

By Component¶

API/Backend: Check Architecture, Guides > API, and Testing
Frontend: Check Guides > Frontend and Architecture
Producer Portal: Check Guides > Producer Portal and Planning
Check-in App: Check app-specific README in /apps/checkin/

By Purpose¶

Learning the system: Start with Architecture documentation
Implementing features: Check Planning and relevant guides
Deploying/Operating: Check Operations documentation
Testing: Check Testing documentation
Historical context: Check Archive for completed work

📏 Documentation Standards¶

All documentation in this directory follows these conventions:

File naming: kebab-case (e.g., database-schema.md)
Metadata headers: All documents include type, status, dates, and related tickets
Markdown format: GitHub-flavored markdown with consistent formatting
Cross-references: Relative links between related documents

✍️ Contributing to Documentation¶

When creating or updating documentation:

Use templates: Start with a template from templates/
Follow naming conventions: Use kebab-case, be descriptive but concise
Add metadata: Include document type, status, dates, and authors
Update this README: Add links to new documents in appropriate sections
Archive completed work: Move finished plans to archive/

📖 App-Specific Documentation¶

For detailed setup and development guides for specific applications:

API: See /apps/api/README.md
Frontend: See /apps/frontend/README.md
Producer Portal: See /apps/producer/README.md
Check-in App: See /apps/checkin/README.md

🆘 Need Help?¶

Can't find what you're looking for? Check the Archive
Document outdated? Please update it or create an issue
Need to create new documentation? Use a template

Last Updated: 2025-11-01 Maintained By: PiqueTickets Development Team