This directory contains comprehensive documentation for Video Annotation Viewer, including user guides, developer resources, and testing procedures.
- DEVELOPER_GUIDE.md - Technical architecture, development setup, and extension points
- FILE_FORMATS.md - Supported VideoAnnotator file formats and specifications
- DEBUGUTILS_GUIDE.md - Browser console debugging utilities and testing tools
- CLIENT_SERVER_COLLABORATION_GUIDE.md - VideoAnnotator API integration (New in v0.3.0)
- TESTING_GUIDE.md - Testing procedures and best practices
Current development and planning documentation:
- implementation_v0.3.0.md - v0.3.0 job management implementation
- ROADMAP_v0.4.0.md - Future feature planning and development roadmap
- IMPLEMENTATION_GUIDE_v0.3.1.md - Quick fixes and improvements guide
QA documentation and testing procedures:
- QA_Checklist_v0.3.0.md - Current comprehensive testing checklist (Updated for v0.3.0)
- QA_Checklist_v0.3.1.md - Focused bug fix testing checklist
Previous versions and historical documentation:
- QA_CHECKLIST_v0.2.0.md - v0.2.0 testing procedures
- implementation_v0.1.0.md - v0.1.0 foundation implementation
- implementation_v0.2.0.md - v0.2.0 feature specifications
- OPENFACE3_IMPLEMENTATION_COMPLETE.md - OpenFace3 integration history
- Original Spec.md - Original project specification document
- Setup: Follow DEVELOPER_GUIDE.md for development environment setup
- API Integration: Review CLIENT_SERVER_COLLABORATION_GUIDE.md for VideoAnnotator server integration (v0.3.0)
- Formats: Check FILE_FORMATS.md for supported annotation formats
- Debugging: Use DEBUGUTILS_GUIDE.md for console testing tools
- Testing: Follow testing/QA_Checklist_v0.3.0.md for comprehensive quality assurance
- VideoAnnotator Repository - Processing pipeline for generating annotation data
- Project Repository - Main project repository and issue tracking
- Main README - Project overview and getting started guide
- v0.4.0 Development Roadmap - Future feature planning
- GitHub Issues - Bug reports and feature requests