@snow-tzu/type-config/benchmark/INDEX.md

Core configuration management system with Spring Boot-like features

# Benchmark Documentation Index

Quick navigation to all benchmark-related documentation.

## 📚 Documentation Files

| Document                                | Description                                  | Audience   |
|-----------------------------------------|----------------------------------------------|------------|
| **[PERFORMANCE.md](../PERFORMANCE.md)** | 📊 Complete performance overview with tables | Everyone   |
| **[README.md](./README.md)**            | 📖 Benchmark suite documentation             | Developers |
| **[QUICKSTART.md](./QUICKSTART.md)**    | 🚀 Quick start guide                         | New users  |

## 🎯 Quick Links by Use Case

### I want to see if this is fast enough for my app

👉 Read [PERFORMANCE.md](../PERFORMANCE.md) - See production guidelines section

### I want to see the latest benchmark numbers

👉 Read [BENCHMARK_RESULTS.md](../BENCHMARK_RESULTS.md) - Tables and charts

### I want to run benchmarks myself

👉 Read [QUICKSTART.md](./QUICKSTART.md) - Step-by-step instructions

### I want to understand the benchmarking methodology

👉 Read [README.md](./README.md) - Detailed documentation

### I want to add new benchmarks

👉 Read [README.md](./README.md) - "Contributing" section

## 📊 Key Performance Tables

### Configuration Loading

| Config Size | Time   | Ops/Sec |
|-------------|--------|---------|
| Small       | 0.11ms | 8.8k    |
| Medium      | 0.16ms | 6.4k    |
| Large       | 0.37ms | 2.7k    |

### Runtime Access

| Method            | Ops/Sec | Recommendation |
|-------------------|---------|----------------|
| Container (typed) | 6.3M    | ✅ Use this     |
| Direct path       | 3.6M    | ⚠️ Fallback    |

### Memory Usage

| Config Size | Memory Overhead |
|-------------|-----------------|
| Small       | +1.5 MB         |
| Medium      | +4 MB           |
| Large       | +14 MB          |

## 🚀 Quick Commands

```bash
# Run all benchmarks
yarn benchmark

# Configuration loading performance
yarn benchmark:loading

# Memory usage analysis
yarn benchmark:memory
```

## 📝 File Structure

```
packages/core/
├── PERFORMANCE.md              # Complete performance guide
├── BENCHMARK_RESULTS.md        # Latest results
├── README.md                   # Main package README
└── benchmark/
    ├── INDEX.md               # This file
    ├── README.md              # Benchmark suite docs
    ├── QUICKSTART.md          # Quick start guide
    ├── utils.ts               # Benchmark utilities
    ├── config-loading.bench.ts # Loading benchmarks
    ├── memory.bench.ts        # Memory benchmarks
    └── index.ts               # Main runner
```

## 🎓 Learning Path

1. **New to Type Config?**
    - Start with [../README.md](../README.md#performance)
    - Quick overview of performance characteristics

2. **Evaluating performance?**
    - Read [PERFORMANCE.md](../PERFORMANCE.md)
    - See production guidelines for your use case

3. **Need exact numbers?**
    - Run benchmarks yourself: [QUICKSTART.md](./QUICKSTART.md)

4. **Contributing?**
    - Read [README.md](./README.md)
    - Follow benchmark suite documentation

## ❓ Common Questions

**Q: Is Type Config fast enough for production?**  
A: Yes! See [PERFORMANCE.md](../PERFORMANCE.md#production-guidelines) for your use case.

**Q: How do I run benchmarks?**  
A: `yarn benchmark` - See [QUICKSTART.md](./QUICKSTART.md) for details.

**Q: What hardware were benchmarks run on?**  
A: Apple M1/M2, 16GB RAM, macOS.

**Q: Can I trust these numbers?**  
A: Run benchmarks on your hardware: [QUICKSTART.md](./QUICKSTART.md)

**Q: How does it compare to alternatives?**  
A: See [PERFORMANCE.md](../PERFORMANCE.md#benchmarking-comparison)

## 🔗 External Resources

- [Main Project README](../../../README.md#performance)
- [Core Package README](../README.md#benchmarks)
- [Examples](../../../examples/)

---