# Documentation Index - Dubai Metaverse

## Overview

This directory contains comprehensive technical documentation for the Dubai Metaverse project. All documentation is organized by category for easy navigation.

## Quick Navigation

### 🚀 Getting Started
- [Setup Guide](../docs/setup/UE5_INSTALLATION.md) - Complete UE5 installation guide
- [Project Setup](../docs/setup/GETTING_STARTED.md) - Initial project setup
- [Project Settings](../docs/setup/PROJECT_SETTINGS.md) - Engine configuration

### 📋 Planning & Standards
- [Project Charter](../docs/planning/PROJECT_CHARTER.md) - Vision, scope, goals
- [Project Plan](../docs/planning/PROJECT_PLAN.md) - 90-day roadmap
- [Technical Brief](../docs/TECHNICAL_BRIEF.md) - Technical specifications
- [Art Bible](../docs/ART_BIBLE.md) - Visual style guide
- [Naming Conventions](../docs/NAMING_CONVENTIONS.md) - Asset naming standards
- [Pipeline](../docs/PIPELINE.md) - Development workflows

### 🛠 Setup & Configuration
- [UE5 Installation](setup/UE5_INSTALLATION.md) - Complete installation guide (Windows/Linux/WSL)
- [UE5 Disk Space Optimization](setup/UE5_DISK_SPACE_OPTIMIZATION.md) - Optimization guide
- [Build Status](setup/build_status/) - UE5 build monitoring and status
- [Project Settings](setup/PROJECT_SETTINGS.md) - Engine configuration
- [Plugins Guide](setup/PLUGINS.md) - Required plugins and setup
- [Version Control](setup/VERSION_CONTROL.md) - Git LFS setup and workflows
- [Next Steps After Build](setup/NEXT_STEPS_AFTER_BUILD.md) - Post-build setup guide
- [Parallel Tasks While Building](setup/PARALLEL_TASKS_WHILE_BUILDING.md) - Build-time tasks
- [Audio Setup](AUDIO_SETUP.md) - Audio system configuration
- [VR Setup](VR_SETUP.md) - Virtual Reality configuration

### 🔧 Workflows
- [PCG Workflow](PCG_WORKFLOW.md) - Procedural Content Generation
- [Texturing Workflow](TEXTURING_WORKFLOW.md) - Texture creation pipeline
- [Building Pipeline](BUILDING_docs/PIPELINE.md) - Building creation workflow
- [Cinematic Pipeline](CINEMATIC_docs/PIPELINE.md) - Cinematic rendering
- [Houdini Pipeline](HOUDINI_docs/PIPELINE.md) - Houdini integration

### 🎮 Systems
- [Lighting Setup](LIGHTING_SETUP.md) - Lighting configuration
- [Day/Night Cycle](DAY_NIGHT_CYCLE.md) - Time-of-day system
- [Vehicle System](VEHICLE_SYSTEM.md) - Vehicle implementation
- [Water System](WATER_SYSTEM.md) - Water simulation
- [Particle FX](PARTICLE_FX.md) - Particle effects
- [MetaHuman Pipeline](METAHUMAN_docs/PIPELINE.md) - MetaHuman NPCs
- [NPC Behavior](NPC_BEHAVIOR.md) - NPC AI and behavior
- [NPC Dialogue](NPC_DIALOGUE.md) - NPC dialogue system
- [Facial Capture](FACIAL_CAPTURE.md) - Facial animation

### 🎯 Gameplay
- [Interaction System](INTERACTION_SYSTEM.md) - Player interactions
- [Player Controls](PLAYER_CONTROLS.md) - Control scheme
- [Quest System](QUEST_SYSTEM.md) - Quest framework

### ⚡ Optimization
- [Performance Optimization](optimization/PERFORMANCE_OPTIMIZATION.md) - Performance tuning
- [Performance Targets](optimization/PERFORMANCE_TARGETS.md) - Performance goals
- [LOD Guidelines](optimization/LOD_GUIDELINES.md) - Level of Detail guidelines
- [Streaming Setup](optimization/STREAMING_SETUP.md) - World streaming configuration

### 📦 Deployment
- [Build Packaging](deployment/BUILD_PACKAGING.md) - Project packaging
- [Deployment Guide](deployment/DEPLOYMENT_GUIDE.md) - Deployment process
- [Developer Handoff](deployment/DEVELOPER_HANDOFF.md) - Handoff documentation
- [Pixel Streaming](deployment/PIXEL_STREAMING.md) - Pixel Streaming setup

### 📚 Reference
- [Material Library](reference/MATERIAL_LIBRARY.md) - Material reference
- [Hero Asset Specs](reference/HERO_ASSET_SPECS.md) - Hero asset specifications
- [Command Reference](reference/COMMAND_REFERENCE.md) - All commands and workflows
- [Asset Review Summary](reference/ASSET_REVIEW_SUMMARY.md) - Asset review summary
- [Workflow Review Summary](reference/WORKFLOW_REVIEW_SUMMARY.md) - Workflow review summary

### 📋 Planning & Assets
- [Project Charter](planning/PROJECT_CHARTER.md) - Vision, scope, goals
- [Project Plan](planning/PROJECT_PLAN.md) - 90-day roadmap
- [District Selection](planning/DISTRICT_SELECTION.md) - Target district analysis
- [Milestones](planning/MILESTONES.md) - Milestone tracking
- [Asset Catalog](assets/ASSET_CATALOG.md) - Complete asset catalog
- [Asset List](assets/ASSET_LIST.md) - Asset requirements by tier
- [Asset Tracking](assets/ASSET_TRACKING.md) - Asset status tracking
- [Blockout Review](planning/BLOCKOUT_REVIEW.md) - Blockout validation
- [Photogrammetry Guide](planning/PHOTOGRAMMETRY_GUIDE.md) - Photogrammetry workflow
- [Data Sources](planning/DATA_SOURCES.md) - Geospatial data sources

### 🧪 Testing & Quality
- [Testing Checklist](TESTING_CHECKLIST.md) - Testing procedures
- [Bug Tracking](BUG_TRACKING.md) - Bug tracking workflow

### 🔧 Troubleshooting
- [FAQ](troubleshooting/FAQ.md) - Frequently asked questions
- [Troubleshooting Guide](troubleshooting/TROUBLESHOOTING.md) - Common issues and solutions
- [GitHub Auth Fix](troubleshooting/GITHUB_AUTH_FIX.md) - GitHub authentication issues
- [.NET SDK Fix](troubleshooting/QUICK_FIX_DOTNET.md) - .NET SDK installation issues

---

## Documentation Categories

### Setup Documentation
Installation and configuration guides:
- [UE5 Installation](setup/UE5_INSTALLATION.md)
- [Audio Setup](AUDIO_SETUP.md)
- [VR Setup](VR_SETUP.md)
- [Pixel Streaming](PIXEL_STREAMING.md)

### Workflow Documentation
Development workflows and pipelines:
- [PCG Workflow](PCG_WORKFLOW.md)
- [Texturing Workflow](TEXTURING_WORKFLOW.md)
- [Building Pipeline](BUILDING_docs/PIPELINE.md)
- [Cinematic Pipeline](CINEMATIC_docs/PIPELINE.md)
- [Houdini Pipeline](HOUDINI_docs/PIPELINE.md)

### System Documentation
Technical system documentation:
- [Lighting Setup](LIGHTING_SETUP.md)
- [Day/Night Cycle](DAY_NIGHT_CYCLE.md)
- [Vehicle System](VEHICLE_SYSTEM.md)
- [Water System](WATER_SYSTEM.md)
- [Particle FX](PARTICLE_FX.md)
- [MetaHuman Pipeline](METAHUMAN_docs/PIPELINE.md)
- [NPC Behavior](NPC_BEHAVIOR.md)
- [NPC Dialogue](NPC_DIALOGUE.md)
- [Facial Capture](FACIAL_CAPTURE.md)

### Gameplay Documentation
Player-facing systems:
- [Interaction System](INTERACTION_SYSTEM.md)
- [Player Controls](PLAYER_CONTROLS.md)
- [Quest System](QUEST_SYSTEM.md)

### Optimization Documentation
Performance and optimization:
- [Performance Optimization](PERFORMANCE_OPTIMIZATION.md)
- [LOD Guidelines](LOD_GUIDELINES.md)
- [Streaming Setup](STREAMING_SETUP.md)

### Deployment Documentation
Build and deployment:
- [Build Packaging](BUILD_PACKAGING.md)
- [Deployment Guide](DEPLOYMENT_GUIDE.md)
- [Developer Handoff](DEVELOPER_HANDOFF.md)

### Reference Documentation
Reference materials:
- [Material Library](MATERIAL_LIBRARY.md)
- [Hero Asset Specs](HERO_ASSET_SPECS.md)

### Testing Documentation
Quality assurance:
- [Testing Checklist](TESTING_CHECKLIST.md)
- [Bug Tracking](BUG_TRACKING.md)

---

## Documentation Standards

All documentation follows these standards:

### Structure
- Clear table of contents
- Overview section
- Prerequisites listed
- Step-by-step instructions
- Troubleshooting section
- Related documentation links

### Format
- Markdown format (.md)
- Code blocks with syntax highlighting
- Screenshots where helpful
- Clear section headers

### Maintenance
- Regular updates as project evolves
- Version numbers for major changes
- Last updated dates
- Links to related docs

---

## Contributing to Documentation

When adding or updating documentation:

1. **Follow the template**: Use consistent structure
2. **Add to index**: Update this README.md
3. **Cross-reference**: Link to related docs
4. **Test instructions**: Verify all commands work
5. **Update dates**: Set last updated date

### Documentation Template

```markdown
# Document Title

## Overview
Brief description

## Table of Contents
- [Section 1](#section-1)
- [Section 2](#section-2)

## Prerequisites
- Requirement 1
- Requirement 2

## [Section 1]
Content...

## Related Documentation
- [Link to related doc]
- [Link to related doc]

## Troubleshooting
Common issues and solutions

## References
- External links
- Related documentation
```

---

## Search Tips

### Finding Documentation

1. **By Category**: Use the category sections above
2. **By Purpose**: Check Quick Navigation
3. **By File Name**: Most files are descriptively named
4. **By Content**: Use your editor's search function

### Common Searches

- **Installation**: See [Setup Documentation](#setup-documentation)
- **Workflows**: See [Workflow Documentation](#workflow-documentation)
- **Systems**: See [System Documentation](#system-documentation)
- **Performance**: See [Optimization Documentation](#optimization-documentation)
- **Deployment**: See [Deployment Documentation](#deployment-documentation)

---

## Related Documentation

### Root Level Documentation
- [README.md](../README.md) - Project overview
- [docs/planning/PROJECT_CHARTER.md](../docs/planning/PROJECT_CHARTER.md) - Project vision
- [docs/planning/PROJECT_PLAN.md](../docs/planning/PROJECT_PLAN.md) - Production roadmap
- [docs/TECHNICAL_BRIEF.md](../docs/TECHNICAL_BRIEF.md) - Technical specs
- [docs/setup/GETTING_STARTED.md](../docs/setup/GETTING_STARTED.md) - Getting started guide

### Configuration Files
- [docs/setup/PROJECT_SETTINGS.md](../docs/setup/PROJECT_SETTINGS.md) - Engine settings
- [docs/setup/PLUGINS.md](../docs/setup/PLUGINS.md) - Plugin requirements
- [docs/setup/VERSION_CONTROL.md](../docs/setup/VERSION_CONTROL.md) - Version control setup

---

**Last Updated**: 2024  
**Maintained By**: Dubai Metaverse Team