# Documentation Index

## Start Here

| Doc | Description | Audience |
|-----|-------------|----------|
| [pipeline.md](pipeline.md) | **Standard Pipeline (v1.5.1)** — 4-step architecture, why each step works, parameters, validation results | Developers using the production pipeline |
| [configuration.md](configuration.md) | Config file reference — LLM providers (DeepSeek / OpenRouter), API keys, env overrides | Everyone |
| [installation.md](installation.md) | Setup: pip, Docker, Colab, GPU | Everyone |

## Reference

| Doc | Description | Audience |
|-----|-------------|----------|
| [techniques.md](techniques.md) | v1.0 four-methodology deep dive (Translation Chain, LLM Rewriting, Detection-Guided, Mixed-Engine) | Researchers, customizers |
| [api-reference.md](api-reference.md) | CLI + Python + REST API for both Standard Pipeline and v1.0 dispatcher | Developers |
| [n8n-guide.md](n8n-guide.md) | Import & run the n8n workflow (no-code) | No-code users |

## Comparison & FAQ

| Doc | Description |
|-----|-------------|
| [lynote-comparison.md](lynote-comparison.md) | Open-source (this repo) vs Lynote.ai feature comparison |
| [faq.md](faq.md) | Common questions: API keys, processing time, chain customization |

## Quick Navigation

```
New to this repo?
  → Read installation.md → pipeline.md → try examples/example_usage.py

Want to understand the science?
  → Read techniques.md → examples/showcase/ (real step-by-step traces)

Want no-code?
  → Read n8n-guide.md → import n8n/humanize_standard.json

Want the full solution?
  → Visit lynote.ai (Standard + Advanced + Focus, auto-selected)
```
