History

luo jiyin 979a461af5 docs: move completed async migration to Completed Features (#2146 ) - Move time.sleep() -> asyncio.sleep() from Planned to Completed Features - Clean up duplicate entries in TODO.md Ensures completed async optimizations are properly tracked.		2026-04-12 16:48:48 +08:00
..
API.md	docs(api): document recursion_limit for LangGraph API runs (#1929 )	2026-04-10 09:28:57 +08:00
APPLE_CONTAINER.md	Fix command syntax for container image pull (#1349 )	2026-03-26 00:14:08 +08:00
ARCHITECTURE.md	fix(threads): clean up local thread data after thread deletion (#1262 )	2026-03-24 00:36:08 +08:00
AUTO_TITLE_GENERATION.md	docs: fix some broken links (#1864 )	2026-04-05 15:35:42 +08:00
CONFIGURATION.md	feat(dx): Setup Wizard + doctor command — closes #2030 (#2034 )	2026-04-10 17:43:39 +08:00
FILE_UPLOAD.md	refactor: split backend into harness (deerflow.) and app (app.) (#1131 )	2026-03-14 22:55:52 +08:00
GUARDRAILS.md	feat(guardrails): add pre-tool-call authorization middleware with pluggable providers (#1240 )	2026-03-23 18:07:33 +08:00
HARNESS_APP_SPLIT.md	refactor: split backend into harness (deerflow.) and app (app.) (#1131 )	2026-03-14 22:55:52 +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	fix(memory): inject stored facts into system prompt memory context (#1083 )	2026-03-13 14:37:40 +08:00
MEMORY_IMPROVEMENTS_SUMMARY.md	refactor: split backend into harness (deerflow.) and app (app.) (#1131 )	2026-03-14 22:55:52 +08:00
MEMORY_SETTINGS_REVIEW.md	feat: support manual add and edit for memory facts (#1538 )	2026-03-29 23:53:23 +08:00
PATH_EXAMPLES.md	refactor: split backend into harness (deerflow.) and app (app.) (#1131 )	2026-03-14 22:55:52 +08:00
README.md	fix(backend): stream DeerFlowClient AI text as token deltas (#1969 ) (#1974 )	2026-04-10 18:16:38 +08:00
SETUP.md	docs(SETUP): correct setup documentation links (#1478 )	2026-03-27 22:44:01 +08:00
STREAMING.md	fix(backend): stream DeerFlowClient AI text as token deltas (#1969 ) (#1974 )	2026-04-10 18:16:38 +08:00
TITLE_GENERATION_IMPLEMENTATION.md	docs: fix some broken links (#1864 )	2026-04-05 15:35:42 +08:00
TODO.md	docs: move completed async migration to Completed Features (#2146 )	2026-04-12 16:48:48 +08:00
memory-settings-sample.json	feat: support manual add and edit for memory facts (#1538 )	2026-03-29 23:53:23 +08:00
middleware-execution-flow.md	feat: add create_deerflow_agent SDK entry point (Phase 1) (#1203 )	2026-03-29 15:31:18 +08:00
plan_mode_usage.md	refactor: split backend into harness (deerflow.) and app (app.) (#1131 )	2026-03-14 22:55:52 +08:00
rfc-create-deerflow-agent.md	feat: add create_deerflow_agent SDK entry point (Phase 1) (#1203 )	2026-03-29 15:31:18 +08:00
rfc-extract-shared-modules.md	refactor: extract shared skill installer and upload manager to harness (#1202 )	2026-03-25 16:28:33 +08:00
rfc-grep-glob-tools.md	feat(sandbox): add built-in grep and glob tools (#1784 )	2026-04-03 16:03:06 +08:00
summarization.md	refactor: split backend into harness (deerflow.) and app (app.) (#1131 )	2026-03-14 22:55:52 +08:00
task_tool_improvements.md	refactor: split backend into harness (deerflow.) and app (app.) (#1131 )	2026-03-14 22:55:52 +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
STREAMING.md	Token-level streaming design: Gateway vs DeerFlowClient paths, `stream_mode` semantics, per-id dedup
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
├── STREAMING.md               # Token-level streaming design
├── AUTO_TITLE_GENERATION.md   # Title generation
├── TITLE_GENERATION_IMPLEMENTATION.md  # Title implementation details
└── TODO.md                    # Roadmap and issues