DOCS_INDEX.md

Frfr Documentation Index

Quick reference to find the right documentation for your needs.

Getting Started

Document	Purpose
QUICKSTART.md	Get up and running in 5 minutes
README.md	Full project overview and usage

Architecture & Design

Document	Purpose
DESIGN.md	System architecture and design decisions

Features & Implementation

Document	Purpose
SESSION_MANAGEMENT.md	Document-aware sessions with LLM naming
ENHANCED_EXTRACTION.md	Enhanced extraction with metadata fields
MAXIMUM_DEPTH_MODE.md	Maximum depth extraction philosophy
PARALLEL_AND_RECOVERY.md	Parallel processing and resume capability
STRUCTURAL_EXTRACTION.md	Structure-aware extraction

Quick Navigation

"I want to..."

• ...get started quickly → QUICKSTART.md
• ...understand the architecture → DESIGN.md
• ...learn about sessions → SESSION_MANAGEMENT.md
• ...understand extraction features → ENHANCED_EXTRACTION.md
• ...resume an interrupted extraction → PARALLEL_AND_RECOVERY.md

Documentation Structure

frfr/
├── README.md                          # Main documentation
└── docs/
    ├── QUICKSTART.md                  # 5-minute setup
    ├── DESIGN.md                      # Architecture & philosophy
    ├── DOCS_INDEX.md                  # This file
    ├── SESSION_MANAGEMENT.md          # Multi-document sessions
    ├── ENHANCED_EXTRACTION.md         # Enhanced extraction guide
    ├── MAXIMUM_DEPTH_MODE.md          # Maximum depth philosophy
    ├── PARALLEL_AND_RECOVERY.md       # Parallel processing & resume
    └── STRUCTURAL_EXTRACTION.md       # Structure-aware extraction

For Different Roles

End Users

1. QUICKSTART.md - Get started quickly
2. README.md - Full usage guide
3. SESSION_MANAGEMENT.md - Multi-document sessions

Developers

1. README.md - Project overview
2. DESIGN.md - Architecture and philosophy
3. ENHANCED_EXTRACTION.md - Extraction features

---

Last updated: 2025-11-14 - Streamlined to 7 core documents (Docker/Temporal removed)