# GitFlow Analytics Documentation

Welcome to the complete documentation for GitFlow Analytics - a powerful tool for analyzing Git repositories to generate comprehensive developer productivity insights.

## 🚀 Quick Navigation

### 📊 For Engineering Managers
Non-technical guides for understanding team insights:
- **[Manager's Quick Start](managers/quickstart.md)** - Get insights in 5 minutes (no installation required)
- **[Understanding Reports](managers/interpreting-reports.md)** - How to read GitFlow Analytics reports
- **[Metrics Reference](managers/metrics-reference.md)** - Plain-language metric definitions
- **[Dashboard Guide](managers/dashboard-guide.md)** - Create Excel/Google Sheets dashboards
- **[Manager FAQ](managers/faq.md)** - Common questions answered
- **[All Manager Docs](managers/)** - Complete manager documentation

### 👋 New to GitFlow Analytics?
Start here to get up and running quickly:
- **[Installation Guide](getting-started/installation.md)** - Set up GitFlow Analytics
- **[Quick Start Tutorial](getting-started/quickstart.md)** - 5-minute walkthrough
- **[Your First Analysis](getting-started/first-analysis.md)** - Analyze your first repository

### 📖 User Guides
Comprehensive guides for common tasks:
- **[LLM Classification Guide](guides/LLM_CLASSIFICATION_GUIDE.md)** - AI-powered commit categorization
- **[ML Categorization](guides/ml-categorization.md)** - Machine learning features setup
- **[Interactive Launcher](guides/interactive-launcher.md)** - Streamlined analysis workflow
- **[Identity Resolution](guides/identity-resolution-enhanced.md)** - Enhanced developer identity detection
- **[Managing Aliases](guides/managing-aliases.md)** - Developer identity management
- **[PM Platform Setup](guides/pm-platform-setup.md)** - Project management integration
- **[ChatGPT Setup](guides/chatgpt-setup.md)** - AI-powered qualitative analysis
- **[Troubleshooting](guides/troubleshooting.md)** - Common issues and solutions

### 💡 Examples & Use Cases
Real-world scenarios and templates:
- **[Interactive Launcher Examples](examples/interactive-launcher-examples.md)** - Complete launcher workflows
- **[Story Points Configuration](examples/story-points-configuration.md)** - JIRA integration setup
- **[More Examples](examples/)** - Browse all available examples and use cases

### 📚 Reference Documentation
Technical specifications and API details:
- **[CLI Commands](reference/cli-commands.md)** - Complete command-line reference
- **[Configuration Schema](reference/configuration-schema.md)** - YAML structure specification
- **[JSON Export Format](reference/json-export-schema.md)** - Data export documentation
- **[Caching System](reference/cache-system.md)** - Performance and caching details

### 🛠️ Developer Resources
For contributors and developers:
- **[Contributing Guide](developer/contributing.md)** - How to contribute to the project
- **[Development Setup](developer/development-setup.md)** - Local development environment
- **[Refactoring Guide](developer/refactoring-guide.md)** - Code quality improvement tracking
- **[Training Guide](developer/training-guide.md)** - ML training and development
- **[Project Organization](developer/project-organization.md)** - Project structure standards
- **[All Developer Docs](developer/)** - Complete developer documentation

### 🏗️ Architecture & Design
System design and technical decisions:
- **[ML Pipeline](architecture/ml-pipeline.md)** - Machine learning architecture
- **[Branch Analysis Optimization](architecture/branch-analysis-optimization.md)** - Performance optimization
- **[Caching Strategy](architecture/caching-strategy.md)** - Incremental processing design
- **[LLM Classifier Refactoring](architecture/llm-classifier-refactoring.md)** - AI integration architecture
- **[Design Documents](design/)** - Detailed design decisions

### 🚀 Deployment & Operations
Production deployment and scaling:
- **[Deployment Guide](deployment/)** - Production deployment documentation
- **[Security Policy](SECURITY.md)** - Security best practices and vulnerability reporting

## 🎯 Documentation by Use Case

### I want to...

**Understand team productivity (Manager)**
→ [Manager Quick Start](managers/quickstart.md) → [Report Interpretation](managers/interpreting-reports.md) → [Dashboard Guide](managers/dashboard-guide.md)

**Analyze a single repository**
→ [Installation](getting-started/installation.md) → [Quick Start](getting-started/quickstart.md) → [Interactive Launcher](examples/interactive-launcher-examples.md)

**Set up organization-wide analysis**
→ [PM Platform Setup](guides/pm-platform-setup.md) → [Identity Resolution](guides/identity-resolution-enhanced.md) → [Managing Aliases](guides/managing-aliases.md)

**Integrate with CI/CD pipelines**
→ [CLI Reference](reference/cli-commands.md) → [Interactive Launcher](guides/interactive-launcher.md)

**Contribute to the project**
→ [Contributing Guide](developer/contributing.md) → [Development Setup](developer/development-setup.md)

**Understand the architecture**
→ [ML Pipeline](architecture/ml-pipeline.md) → [Design Documents](design/)

**Deploy in production**
→ [Deployment Guide](deployment/) → [Security Policy](SECURITY.md)

## 🔍 Search Tips

- Use your browser's search (Ctrl/Cmd+F) to find specific topics
- Check the [Configuration Schema](reference/configuration-schema.md) for YAML options
- Review [Troubleshooting](guides/troubleshooting.md) for common issues
- Browse [Examples](examples/) for similar use cases

## 📝 Documentation Standards

This documentation follows our [Documentation Standards](DOCUMENTATION-STANDARDS.md) and [Structure Guidelines](STRUCTURE.md):
- **Progressive disclosure** - Start simple, dive deeper as needed
- **Task-oriented** - Organized around what you want to accomplish
- **Tested examples** - All code samples are validated and working
- **Cross-referenced** - Related topics are linked together
- **Audience-focused** - Clear paths for users, developers, and contributors

## 🤝 Help & Community

- **Issues & Bugs**: [GitHub Issues](https://github.com/bobmatnyc/gitflow-analytics/issues)
- **Feature Requests**: [GitHub Discussions](https://github.com/bobmatnyc/gitflow-analytics/discussions)
- **Contributing**: See our [Contributing Guide](developer/contributing.md)

## 📊 What GitFlow Analytics Does

GitFlow Analytics extracts insights from Git repositories including:
- **Developer productivity metrics** with identity resolution
- **ML-powered commit categorization** (85-95% accuracy)
- **Project activity analysis** across multiple repositories
- **DORA metrics** and development velocity tracking
- **Beautiful reporting** in CSV, JSON, and Markdown formats

All without requiring external project management tools like JIRA or Linear.

---

**Need help?** Start with the [Quick Start Tutorial](getting-started/quickstart.md) or check [Troubleshooting](guides/troubleshooting.md).

**Contributing?** See the [Contributing Guide](developer/contributing.md) and [Development Setup](developer/development-setup.md).

**Last Updated**: January 2025