the_paragliding_app

Documentation Index

Welcome to The Paragliding App documentation. All documentation is organized in this /docs/ directory.

For Users

For Developers

Core Architecture & Design

Developer References (Claude Code)

API Documentation

External service integrations and API references:

Performance Documentation

Airspace rendering pipeline optimization work:

Development Setup

Platform-specific development environment setup guides:

Historical Documentation

Archived documentation for reference (not current implementation):

Documentation Organization

docs/
├── README.md                     # This file - documentation index
├── privacy_policy.md            # Privacy policy (required for app stores)
│
├── ARCHITECTURE.md              # Core architecture docs
├── TECHNICAL_DESIGN.md
├── FUNCTIONAL_SPECIFICATION.md
│
├── IGC_TRIMMING.md              # Claude Code references
├── TIMESTAMPS.md
├── DATABASE.md
├── ADDING_WEATHER_PROVIDERS.md
│
├── user/                        # User-facing documentation
│   ├── User_Manual.md
│   └── google_play_store_description.md
│
├── api/                         # External API integration guides
│   ├── OPENAIP_API_STRUCTURE.md
│   ├── AVIATION_WEATHER_CENTER_API.md
│   ├── WEATHER_STATIONS.md
│   ├── BOM_WEATHER_STATIONS.md
│   └── FORECAST.md
│
├── performance/                 # Performance optimization documentation
│   ├── AIRSPACE_PIPELINE_ARCHITECTURE.md
│   ├── AIRSPACE_PERFORMANCE_OPTIMIZATION.md
│   └── AIRSPACE_PERFORMANCE_METRICS.md
│
├── setup/                       # Development environment setup
│   ├── CHROMEOS_FLUTTER_SETUP.md
│   └── WIRELESS_ADB_SETUP.md
│
└── archive/                     # Historical documentation
    ├── improved_how_to_instructions.md
    ├── 3D_TECH_RECOMMENDATION.md
    ├── AIRSPACE_ALGORITHM_ANALYSIS.md
    ├── LINEAR_OPTIMIZATION_RESULTS.md
    ├── bidirectional-chart-sync.md
    ├── EDIT_SITES_CLICK_DRAG_SPECIFICATION.md
    ├── Cesium_PRD.md
    ├── Cesium_Native_Analysis.md
    ├── MAPLIBRE_VS_CESIUM_COMPARISON.md
    ├── maps.md
    ├── preferences.md
    └── TRACK_RENDERING.md

Contributing to Documentation

When adding or updating documentation:

  1. Choose the right location:
    • User-facing docs → user/
    • API integration guides → api/
    • Performance analysis → performance/
    • Setup guides → setup/
    • Core architecture → root level
    • Outdated/historical → archive/

  2. Update this README to include new documentation in the appropriate section

  3. Use markdown format with clear headings and code examples

  4. Include dates in technical documents (e.g., “Last Updated: YYYY-MM-DD”)

  5. Link related docs to help readers navigate between connected topics

Last Updated: 2025-01-12