DOCUMENTATION.md

Documentation Index

This document provides an index to all documentation files in the project.

⚠️ IMPORTANT: All developers and AI agents should read README.md in this folder before working on the project.

📚 Main Documentation

Getting Started

• README.md - Main project documentation, quick start guide, features overview (in project root)
• README.md - Documentation guide - READ THIS FIRST ⚠️
• DEVELOPMENT.md - Development setup, build instructions, architecture overview

Status & Progress

• PROJECT_STATUS.md - Overall project status and progress summary
• CURRENT_STATUS.md - Detailed conversion status, completed features, next priorities
• CHANGELOG.md - Changelog of features and changes
• MISSING_FEATURES.md - Known missing features and TODO items
• UI_PROGRESS.md - UI implementation progress

Architecture & Design

• ARCHITECTURE.md - System architecture, component overview, data flow
• CONVERSION_GUIDE.md - Conversion patterns from ActionScript to TypeScript

UI Documentation

• UI_SETUP.md - React UI framework setup guide
• UI_COMPONENTS.md - React component documentation
• ELECTRON_SETUP.md - Electron integration guide
• ELECTRON_FIXES.md - Known Electron issues and fixes
• CANVAS_WINDOWS_SETUP.md - Canvas module setup for Windows

📖 Quick Reference

For Developers

1. Start: Read README.md in this folder - REQUIRED READING ⚠️
2. Start with DEVELOPMENT.md for setup
3. Read ARCHITECTURE.md for system design
4. Check PROJECT_STATUS.md and CURRENT_STATUS.md for what's done
5. See UI_COMPONENTS.md for component usage

For Users

1. Start with README.md in project root for installation
2. Check PROJECT_STATUS.md for current state
3. See CHANGELOG.md for recent changes

🎯 Current Status

Overall Progress: ~90% Complete

• Backend: 100% ✅
• UI: 90% ✅
• Remaining: Enhanced features, testing, additional dialogs

📝 Documentation Standards

All documentation follows these conventions:

• Markdown format (.md files)
• Clear section headers
• Code examples where applicable
• Links to related documents
• Status indicators (✅ ⏳ 🚧)

🔄 Keeping Documentation Updated

Documentation is updated as features are completed:

• CURRENT_STATUS.md - Updated after each session
• PROJECT_STATUS.md - Updated for major milestones
• CHANGELOG.md - Updated with new features
• Component docs - Updated when components change