Skip to content

index.md

Latest commit

 

History

History
118 lines (100 loc) · 6.38 KB

index.md

File metadata and controls

118 lines (100 loc) · 6.38 KB

Documentation Index

Complete directory structure and file listing for the Street Support Platform documentation.

📁 Directory Structure

docs/
├── README.md                                    # 📖 Main documentation overview
├── INDEX.md                                     # 📋 This file - complete index
│
├── project-planning/                            # 🎯 Strategic Planning
│   ├── README.md                               # Overview of planning documents
│   └── API-Project-Plan.md                     # Complete API rebuild strategy
│
├── development/                                 # 🛠️ Technical Implementation
│   ├── README.md                               # Development guide overview
│   ├── api-scaffold-and-db-helper-summary.md  # API patterns & database integration
│   ├── confirm-and-test-mongo-db.md           # MongoDB setup & testing
│   └── IMAGE_OPTIMISATION.md                  # Performance optimisation guide
│
├── testing/                                    # 🧪 Quality Assurance
│   ├── README.md                              # Testing strategy overview
│   ├── E2E_TESTING_STRATEGY.md               # ⭐ MSW-style mocking solution
│   └── TESTING_AND_FALLBACKS.md              # Legacy fallback system
│
├── deployment/                                 # 🚀 CI/CD & Operations
│   ├── README.md                              # Deployment guide overview
│   ├── workflow.md                            # GitHub Actions CI/CD pipeline
│   ├── secrets.md                             # Security & secrets management
│   └── vercel-configuration.md                # Production deployment settings
│
├── security/                                   # 🛡️ Security & Compliance
│   ├── README.md                              # Security strategy overview
│   ├── application-security.md                # Code-level security measures
│   ├── infrastructure-security.md             # Deployment & hosting security
│   └── security-monitoring.md                 # Monitoring & incident response
│
└── design-system/                             # 🎨 UI Components & Patterns
    ├── README.md                              # Design system overview
    ├── buttons.md                             # Button components & variants
    ├── typography.md                          # Text styles & hierarchy
    ├── colors-and-themes.md                  # Brand colours & accessibility
    ├── layout-and-spacing.md                 # Grid system & spacing
    ├── forms-and-inputs.md                   # Form design patterns
    ├── navigation-and-menus.md               # Navigation components
    └── cards-and-content.md                  # Content containers

📊 Documentation Stats

  • Total Files: 23 documentation files
  • Directory Structure: 6 main categories
  • Key Strategies: 4 major technical implementations
  • Coverage: Complete project lifecycle documentation including security

🎯 Quick Navigation

By Audience

By Task

By Priority

  1. 🔥 Critical: E2E Testing Strategy - Enables PR testing
  2. 🛡️ Security: Security Documentation - Comprehensive security measures
  3. ⚡ Important: API Project Plan - Architectural foundation
  4. 🛠️ Essential: GitHub Workflow - CI/CD pipeline
  5. 🎨 Quality: Design System - UI consistency

🏆 Key Achievements Documented

✅ Technical Solutions

  • MSW-Style E2E Testing: Zero-infrastructure testing solution
  • Serverless API Architecture: Scalable, maintainable backend
  • Comprehensive Design System: Accessible, brand-consistent UI
  • Automated CI/CD Pipeline: Reliable deployment process

✅ Documentation Quality

  • Structured Organisation: Logical categorisation by domain
  • Cross-Referenced: Related documents linked appropriately
  • Audience-Focused: Content tailored to reader needs
  • Implementation-Ready: Practical, actionable guidance

✅ Maintenance Strategy

  • Living Documentation: Updated alongside code changes
  • Version Controlled: Full history of changes tracked
  • Searchable Structure: Easy navigation and discovery
  • Future-Proof: Extensible for new features and requirements

🔄 Recent Reorganisation (January 2025)

Previous Structure Issues

  • Flat directory with mixed content types
  • No clear audience targeting
  • Missing overview documentation
  • Limited cross-referencing between docs

Improvements Made

  • Logical Categorisation: 5 clear domains (planning, development, testing, deployment, design)
  • README-Driven: Each directory has overview and navigation
  • Cross-Referencing: Related docs properly linked
  • Audience Targeting: Content organised by reader needs
  • Quick Start Paths: Clear entry points for different roles

This index is automatically maintained and reflects the current documentation structure. Last updated: August 2025