INDEX.md

Documentation Index

Welcome to the auto-image-diff documentation! This index provides a comprehensive guide to all available documentation.

🚀 Getting Started

• README - Project overview and quick start
• Getting Started Guide - Detailed setup and first steps
• Examples - Code examples and use cases

🏗️ Architecture & Design

• Architecture Overview - System design and component structure
• API Reference - Complete API documentation
• API Overview - Quick API reference

📚 Feature Documentation

Core Features

• Image Processing - Alignment and comparison
• Batch Processing - Multiple image handling
• Classification System - Difference categorization

Advanced Features

• CSS Fix Suggestions - Automatic style fixes
• Progressive Refinement - Interactive improvement
• Metadata Enhancement - Tracking and embedding
• Smart Pairing - Intelligent file matching

🛠️ Development

• Testing Guide - Running and writing tests
• Contributing - How to contribute
• Development Workflow - Local development setup

🔧 Configuration & Setup

• Environment Setup - Environment variables and configuration
• OpenCV Setup - Advanced feature setup
• CI/CD Integration - GitHub Actions and more

📖 Guides & Tutorials

Usage Guides

• CLI Usage - Command-line interface guide
• Programmatic Usage - Using as a library
• Batch Processing - Processing multiple images
• AI Coding Agents - Using with Claude Code and other AI tools

Feature Guides

• Exclusion Regions - Ignoring dynamic content
• Classification - Understanding change types
• Report Generation - Creating visual reports

🐛 Troubleshooting

• Troubleshooting Guide - Common issues and solutions
• FAQ - Frequently asked questions
• Error Reference - Error codes and meanings

📊 Reference

Technical Reference

• Change Log - Version history
• Release Notes - Detailed release information
• Technical Debt - Known issues and improvements

Planning & Design

• Initial Planning - Original design documents
  • Detailed PRD
  • Methodology
  • Figma Guide

🔍 Quick Links

By Use Case

Visual Regression Testing

• Getting Started
• CI Integration
• Exclusions

UI Development

• CSS Fix Suggestions
• Progressive Refinement
• Classification

Batch Processing

• Batch Guide
• Smart Pairing
• Reports

AI-Assisted Development

• AI Coding Agents
• CSS Fix Suggestions
• Classification

By Technology

ImageMagick

• Architecture
• Alignment Methods

OpenCV

• Setup Guide
• Feature Matching

TypeScript/Node.js

• API Reference
• Development

📝 Documentation Standards

All documentation follows these conventions:

• Markdown formatting with GitHub Flavored Markdown
• Code examples for all major features
• Cross-references between related topics
• Version tags for API changes
• Visual diagrams where helpful

🤝 Need Help?

• Open an Issue
• Discussions
• Examples - Working code samples