History

Willem Jiang cf1c4a68ea docs: fix stream_mode examples for runs stream (#1033 ) (#1039 )		2026-03-10 11:19:31 +08:00
..
API.md	docs: fix stream_mode examples for runs stream (#1033 ) (#1039 )	2026-03-10 11:19:31 +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 Novita AI as optional LLM provider (#910 )	2026-02-27 11:16:31 +08:00
FILE_UPLOAD.md	fix(uploads): persist thread uploads canonically and fail fast on upload errors (#943 )	2026-03-01 15:35:30 +08:00
MCP_SERVER.md	feat(mcp): add OAuth support for HTTP/SSE MCP servers (#908 )	2026-03-01 22:38:58 +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	feat: add IM channels for Feishu, Slack, and Telegram (#1010 )	2026-03-08 15:21:18 +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.

Quick Links

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

New to DeerFlow? Start with SETUP.md for quick installation
Configuring the system? See CONFIGURATION.md
Understanding the architecture? Read ARCHITECTURE.md
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