ContextQMD
Back to Deer Flow

Documentation

backend/docs/README.md

latest2.0 KB
Original Source

Documentation

This directory contains detailed documentation for the DeerFlow backend.

DocumentDescription
ARCHITECTURE.mdSystem architecture overview
API.mdComplete API reference
CONFIGURATION.mdConfiguration options
SETUP.mdQuick setup guide

Feature Documentation

DocumentDescription
FILE_UPLOAD.mdFile upload functionality
PATH_EXAMPLES.mdPath types and usage examples
summarization.mdContext summarization feature
plan_mode_usage.mdPlan mode with TodoList
AUTO_TITLE_GENERATION.mdAutomatic title generation

Development

DocumentDescription
TODO.mdPlanned features and known issues

Getting Started

  1. New to DeerFlow? Start with SETUP.md for quick installation
  2. Configuring the system? See CONFIGURATION.md
  3. Understanding the architecture? Read ARCHITECTURE.md
  4. Building integrations? Check API.md for API reference

Document Organization

docs/
├── README.md                  # This file
├── ARCHITECTURE.md            # System architecture
├── API.md                     # API reference
├── CONFIGURATION.md           # Configuration guide
├── SETUP.md                   # Setup instructions
├── FILE_UPLOAD.md             # File upload feature
├── PATH_EXAMPLES.md           # Path usage examples
├── summarization.md           # Summarization feature
├── plan_mode_usage.md         # Plan mode feature
├── AUTO_TITLE_GENERATION.md   # Title generation
├── TITLE_GENERATION_IMPLEMENTATION.md  # Title implementation details
└── TODO.md                    # Roadmap and issues