35a15bfe09
- Rewrite CHANGELOG.md to cover platform v1.0.0 and auth fix, with reporting module history preserved as subsection - Replace stale DOCUMENTATION_SUMMARY.txt with current project structure and key decisions - Rewrite MIGRATION_GUIDE.md to document legacy tool consolidation with complete file mappings for hm_qc and video_qc - Add legacy context headers to module docs (legacy_README, legacy_DEV_SETUP, legacy_CLAUDE) pointing to main README Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
73 lines
4 KiB
Text
73 lines
4 KiB
Text
=============================================================================
|
|
HM QC PLATFORM - DOCUMENTATION SUMMARY
|
|
Version 1.0.1 - February 25, 2026
|
|
=============================================================================
|
|
|
|
PROJECT OVERVIEW:
|
|
|
|
Unified QC platform consolidating multiple standalone tools into a single
|
|
Flask application with modular architecture. Replaces the separate hm_qc
|
|
(CLI image/PDF QC), hm_qc_video (video QC), and reporting dashboard tools.
|
|
|
|
=============================================================================
|
|
PROJECT STRUCTURE:
|
|
=============================================================================
|
|
|
|
hm_ai_qc_report_tool/
|
|
├── app.py Main Flask application factory
|
|
├── config.py Application configuration
|
|
├── core/ Shared framework
|
|
│ ├── auth/ Azure AD MSAL authentication (redirect flow)
|
|
│ ├── models/ Database models (SQLAlchemy)
|
|
│ ├── services/ Box client, LLM config
|
|
│ └── utils/ Progress tracker, report parser
|
|
├── modules/
|
|
│ ├── hm_qc/ Image/PDF QC module
|
|
│ │ ├── checks/ New BaseCheck architecture
|
|
│ │ ├── checks/legacy/ Original run_check() implementations (20 files)
|
|
│ │ ├── checks/legacy/ford/ Ford-specific checks (8 files)
|
|
│ │ ├── profiles/ New YAML profiles
|
|
│ │ ├── profiles/legacy/ Original JSON profiles (3 files)
|
|
│ │ ├── launchers/ CLI launchers from original tool
|
|
│ │ └── utils/ Legacy utilities
|
|
│ ├── video_qc/ Video QC module (BETA)
|
|
│ │ ├── checks/legacy/ Original video checks (7 files)
|
|
│ │ ├── profiles/legacy/ Video JSON profiles (1 file)
|
|
│ │ ├── launchers/ CLI/web launchers
|
|
│ │ ├── legacy_web/ Standalone Flask app (preserved)
|
|
│ │ └── utils/ Video utilities
|
|
│ ├── video_master/ Video fingerprinting module (BETA)
|
|
│ └── reporting/ Consolidated report search
|
|
├── database/ SQLite schema
|
|
├── data/ Supporting data (gitignored)
|
|
├── reference/ Test files, results, cheat sheets (gitignored)
|
|
├── static/ Shared CSS/JS
|
|
└── templates/ Shared HTML templates
|
|
|
|
=============================================================================
|
|
DOCUMENTATION FILES:
|
|
=============================================================================
|
|
|
|
README.md Main project documentation (up to date)
|
|
CHANGELOG.md Version history (platform + reporting module)
|
|
DEPLOYMENT_CHECKLIST.md Deployment procedures and verification
|
|
MIGRATION_GUIDE.md Legacy tool to unified platform migration guide
|
|
INTEGRATION_TEST_REPORT.md Static analysis and integration test results
|
|
|
|
modules/hm_qc/legacy_CLAUDE.md Legacy dev guide for HM QC checks
|
|
modules/hm_qc/legacy_README.md Legacy HM QC CLI tool documentation
|
|
modules/hm_qc/legacy_DEV_SETUP.md Legacy dev environment setup
|
|
modules/video_qc/legacy_README.md Legacy Video QC tool documentation
|
|
|
|
=============================================================================
|
|
KEY DECISIONS:
|
|
=============================================================================
|
|
|
|
- Legacy checks preserved in checks/legacy/ with original function pattern
|
|
- New checks use BaseCheck class pattern (modules/*/checks/)
|
|
- Auth uses MSAL redirect flow (not popup) for reliability
|
|
- Root URL renders reporting page directly (no 302 redirect)
|
|
- reference/ and data/supporting/ are gitignored (large test/training data)
|
|
- Backup tarball on Desktop: HM_QC_Bitbucket_backup_20260225_113155.tar.gz
|
|
|
|
=============================================================================
|