deerflow-code/offline-backend-20260512/backend/docs/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
ORDINARY_KNOWLEDGE_SMART_REASONING_RETRIEVAL_ZH.md	普通知识库智能推理检索：管理员数据库开关、原文与 Wiki 首轮双检索、WeKnora 式多轮深读、权限与验收设计
WIKI_HIERARCHY_AND_FOCUS_GENERATION_ZH.md	Wiki 创建时按目录层级生成、按重点要求生成及异步协调设计
KNOWLEDGE_SPACE_RETRIEVAL_AND_WIKI_EXPANSION_ZH.md	知识空间严格优先检索、混合召回、Wiki 图扩展与可编辑全库摘要实现方案
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

Workflow Studio

Document	Description
WORKFLOW_STUDIO_BACKEND_DEV_ZH.md	后端开发基线方案 + 各阶段完成状态
adr/0001-workflow-studio-runtime.md	ADR：Coze 只做画布 / ChatDev 只作参考 / 自建 DAG 调度器（LangGraph 仅作智能体内核）
WORKFLOW_SCHEMA_V1_ZH.md	内部图 Schema v1.0
WORKFLOW_SSE_V1_ZH.md	SSE 事件协议 v1.0
WORKFLOW_OPENAPI_DRAFT_V1.yaml	接口 OpenAPI 草案

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
├── STREAMING.md               # Token-level streaming design
├── AUTO_TITLE_GENERATION.md   # Title generation
├── TITLE_GENERATION_IMPLEMENTATION.md  # Title implementation details
└── TODO.md                    # Roadmap and issues