# Agentic-Jujutsu Documentation Index

> Complete navigation guide for all documentation resources

## 📚 Table of Contents

- [Quick Start](#quick-start)
- [Documentation by Role](#documentation-by-role)
- [Complete File Listing](#complete-file-listing)
- [Learning Paths](#learning-paths)

## 🚀 Quick Start

**New to agentic-jujutsu?** Start here:

1. **Installation & Setup**: [Getting Started - WASM Usage](getting-started/wasm-usage.md)
2. **Quick Benchmark Guide**: [Getting Started - Benchmark Quick Start](getting-started/BENCHMARK_QUICK_START.md)
3. **Main README**: [Project README](../README.md)

## 👥 Documentation by Role

### For Users

**I want to use agentic-jujutsu in my project**

1. [WASM Usage Guide](getting-started/wasm-usage.md) - Complete usage guide for JavaScript/TypeScript
2. [Hooks Integration](api/HOOKS_INTEGRATION.md) - Quick start for hooks
3. [API Reference](api/hooks-integration.md) - Detailed API documentation

### For Developers

**I want to contribute or understand the codebase**

1. [Architecture Overview](architecture/ARCHITECTURE.md) - System design and ADRs
2. [Development Guide](development/testing.md) - Testing strategies and development workflow
3. [Implementation Summary](reports/IMPLEMENTATION_SUMMARY.md) - Core implementation details

### For Researchers

**I want to benchmark or analyze performance**

1. [Benchmark README](benchmarks/README.md) - Comprehensive benchmark system overview
2. [Benchmark Quick Start](getting-started/BENCHMARK_QUICK_START.md) - Fast setup guide
3. [Benchmark Architecture](benchmarks/ARCHITECTURE.md) - Technical design
4. [Scalability Analysis](benchmarks/SCALABILITY.md) - Performance characteristics

### For System Architects

**I want to understand design decisions**

1. [Architecture Overview](architecture/ARCHITECTURE.md) - ADRs and type hierarchy
2. [Benchmark Component Design](benchmarks/COMPONENT_DESIGN.md) - Component architecture
3. [Data Models](benchmarks/DATA_MODELS.md) - Data structure design
4. [Integration Guide](benchmarks/INTEGRATION_GUIDE.md) - System integration patterns

## 📂 Complete File Listing

### Getting Started
- [wasm-usage.md](getting-started/wasm-usage.md) - WASM bindings usage guide
- [BENCHMARK_QUICK_START.md](getting-started/BENCHMARK_QUICK_START.md) - Quick benchmark setup

### Architecture
- [ARCHITECTURE.md](architecture/ARCHITECTURE.md) - Core system architecture, ADRs, type system

### API Reference
- [HOOKS_INTEGRATION.md](api/HOOKS_INTEGRATION.md) - Hooks API quick reference
- [hooks-integration.md](api/hooks-integration.md) - Detailed hooks integration guide

### Development
- [testing.md](development/testing.md) - Testing strategies and guidelines

### Benchmarks
- [README.md](benchmarks/README.md) - Benchmark system overview
- [ARCHITECTURE.md](benchmarks/ARCHITECTURE.md) - Benchmark architecture design
- [COMPONENT_DESIGN.md](benchmarks/COMPONENT_DESIGN.md) - Component specifications
- [DATA_MODELS.md](benchmarks/DATA_MODELS.md) - Data models and schemas
- [INTEGRATION_GUIDE.md](benchmarks/INTEGRATION_GUIDE.md) - Integration patterns
- [SCALABILITY.md](benchmarks/SCALABILITY.md) - Performance and scalability
- [SUMMARY.md](benchmarks/SUMMARY.md) - Executive summary
- [BENCHMARK_DEPENDENCY_GRAPH.md](benchmarks/BENCHMARK_DEPENDENCY_GRAPH.md) - Dependency analysis
- [BENCHMARK_IMPLEMENTATION_PLAN.md](benchmarks/BENCHMARK_IMPLEMENTATION_PLAN.md) - Implementation roadmap
- [BENCHMARK_VISUAL_SUMMARY.md](benchmarks/BENCHMARK_VISUAL_SUMMARY.md) - Visual documentation
- [BENCHMARK_README.md](benchmarks/BENCHMARK_README.md) - Detailed benchmark guide

### Reports
- [BUILD_STATUS.md](reports/BUILD_STATUS.md) - Current build status
- [IMPLEMENTATION_SUMMARY.md](reports/IMPLEMENTATION_SUMMARY.md) - Implementation details
- [INTEGRATION_SUMMARY.md](reports/INTEGRATION_SUMMARY.md) - Integration completion report
- [RUST_IMPLEMENTATION_SUMMARY.md](reports/RUST_IMPLEMENTATION_SUMMARY.md) - Rust implementation details
- [TEST_REPORT.md](reports/TEST_REPORT.md) - Test coverage and results
- [WASM_DELIVERABLES_SUMMARY.md](reports/WASM_DELIVERABLES_SUMMARY.md) - WASM implementation summary

## 🎯 Learning Paths

### Path 1: Quick Integration (30 minutes)

**Goal**: Get agentic-jujutsu running in your project

1. [WASM Usage Guide](getting-started/wasm-usage.md) - Installation and basic usage
2. [Hooks Integration Quick Start](api/HOOKS_INTEGRATION.md) - Enable hooks
3. [Examples](../examples/) - Working code samples

### Path 2: Full Understanding (2-3 hours)

**Goal**: Understand the complete system

1. [Architecture Overview](architecture/ARCHITECTURE.md) - Design decisions
2. [Implementation Summary](reports/IMPLEMENTATION_SUMMARY.md) - Code structure
3. [Hooks Integration Details](api/hooks-integration.md) - Advanced features
4. [Testing Guide](development/testing.md) - Quality assurance

### Path 3: Performance Analysis (1-2 hours)

**Goal**: Benchmark and optimize

1. [Benchmark Quick Start](getting-started/BENCHMARK_QUICK_START.md) - Setup
2. [Benchmark Architecture](benchmarks/ARCHITECTURE.md) - System design
3. [Scalability Analysis](benchmarks/SCALABILITY.md) - Performance tuning
4. [Benchmark README](benchmarks/README.md) - Comprehensive guide

### Path 4: Contributing (3-4 hours)

**Goal**: Make meaningful contributions

1. [Architecture Overview](architecture/ARCHITECTURE.md) - Understand design
2. [Development Guide](development/testing.md) - Development workflow
3. [Build Status](reports/BUILD_STATUS.md) - Current state
4. [Test Report](reports/TEST_REPORT.md) - Testing requirements
5. [Implementation Summary](reports/IMPLEMENTATION_SUMMARY.md) - Code details

## 📊 Documentation Statistics

| Category | Files | Purpose |
|----------|-------|---------|
| Getting Started | 2 | Quick onboarding |
| Architecture | 1 | Design documentation |
| API Reference | 2 | Usage guides |
| Development | 1 | Contributor guides |
| Benchmarks | 11 | Performance analysis |
| Reports | 6 | Status and summaries |
| **Total** | **23** | **Complete coverage** |

## 🔍 Search Tips

### Find by Topic

- **Installation**: `getting-started/wasm-usage.md`
- **Architecture decisions**: `architecture/ARCHITECTURE.md`
- **API usage**: `api/` directory
- **Performance**: `benchmarks/` directory
- **Current status**: `reports/BUILD_STATUS.md`
- **Testing**: `development/testing.md`

### Find by File Type

- **Quick starts**: `getting-started/`
- **Technical specs**: `architecture/` and `benchmarks/ARCHITECTURE.md`
- **Implementation details**: `reports/`
- **Usage guides**: `api/` and `getting-started/`

## 🆘 Getting Help

### Documentation Issues

If you find:
- Broken links → File an issue
- Outdated information → File a PR
- Missing topics → Request in issues

### Where to Ask Questions

1. **Usage questions**: Check `getting-started/` first
2. **Architecture questions**: Review `architecture/`
3. **Performance questions**: See `benchmarks/`
4. **Integration issues**: Check `api/`

## 📝 Contributing to Docs

### Documentation Standards

1. **Markdown format**: Use GitHub-flavored markdown
2. **Code examples**: Include working examples
3. **Links**: Use relative links within docs
4. **Updates**: Keep summaries in sync with code

### File Naming Conventions

- **Guides**: `kebab-case.md` (e.g., `wasm-usage.md`)
- **Summaries**: `SCREAMING_SNAKE_CASE.md` (e.g., `BUILD_STATUS.md`)
- **READMEs**: `README.md` in each directory

## 🔄 Documentation Updates

**Last Updated**: 2025-11-09
**Version**: 0.1.0
**Maintained By**: Agentic Flow Team

### Recent Changes

- 2025-11-09: Reorganized documentation structure
- 2025-11-09: Created comprehensive index
- 2025-11-09: Added learning paths
- 2025-11-07: Added benchmark documentation
- 2025-11-07: Added integration summaries

## 📖 Related Resources

### External Links

- [Main Repository](https://github.com/ruvnet/agentic-flow)
- [Jujutsu VCS](https://github.com/jj-vcs/jj)
- [WASM Bindgen](https://rustwasm.github.io/docs/wasm-bindgen/)
- [Rust Book](https://doc.rust-lang.org/book/)

### Internal Links

- [Project README](../README.md)
- [Examples Directory](../examples/)
- [Tests Directory](../tests/)
- [Source Code](../src/)

---

**Navigation**: [Top](#agentic-jujutsu-documentation-index) | [README](../README.md) | [Documentation Map](DOCUMENTATION_MAP.md)