deerflow2/backend/docs
hetao 498c8b3ec0 feat: fix task polling issue 2026-02-06 17:48:15 +08:00
..
API.md docs: add comprehensive backend documentation 2026-02-01 22:18:25 +08:00
APPLE_CONTAINER.md feat: add Apple Container support with comprehensive documentation and dev tools 2026-02-03 20:41:36 +08:00
ARCHITECTURE.md docs: add comprehensive backend documentation 2026-02-01 22:18:25 +08:00
AUTO_TITLE_GENERATION.md feat: add AIO sandbox provider and auto title generation (#1) 2026-01-14 23:29:18 +08:00
CONFIGURATION.md feat: add skills system for specialized agent workflows (#6) 2026-01-16 14:44:51 +08:00
FILE_UPLOAD.md feat: implement file upload feature 2026-01-23 18:47:39 +08:00
MEMORY_IMPROVEMENTS.md feat: enhance memory system with tiktoken and improved prompt guidelines 2026-02-04 20:44:26 +08:00
MEMORY_IMPROVEMENTS_SUMMARY.md feat: enhance memory system with tiktoken and improved prompt guidelines 2026-02-04 20:44:26 +08:00
PATH_EXAMPLES.md feat: implement file upload feature 2026-01-23 18:47:39 +08:00
README.md docs: add comprehensive backend documentation 2026-02-01 22:18:25 +08:00
SETUP.md feat: add Apple Container support with comprehensive documentation and dev tools 2026-02-03 20:41:36 +08:00
TITLE_GENERATION_IMPLEMENTATION.md feat: add AIO sandbox provider and auto title generation (#1) 2026-01-14 23:29:18 +08:00
TODO.md docs: add comprehensive backend documentation 2026-02-01 22:18:25 +08:00
plan_mode_usage.md feat: integrate todo middleware 2026-01-20 22:38:04 +08:00
summarization.md feat: implement summarization (#14) 2026-01-19 16:17:31 +08:00
task_tool_improvements.md feat: fix task polling issue 2026-02-06 17:48:15 +08:00

README.md

Documentation

This directory contains detailed documentation for the DeerFlow backend.

Document Description
ARCHITECTURE.md System architecture overview
API.md Complete API reference
CONFIGURATION.md Configuration options
SETUP.md Quick setup guide

Feature Documentation

Document Description
FILE_UPLOAD.md File upload functionality
PATH_EXAMPLES.md Path types and usage examples
summarization.md Context summarization feature
plan_mode_usage.md Plan mode with TodoList
AUTO_TITLE_GENERATION.md Automatic title generation

Development

Document Description
TODO.md Planned 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