wsk/deerflow-code
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
main
deerflow-code/offline-backend-20260512/backend/docs
History
gozeros b638b541d0 初始化
2026-09-07 18:24:55 +08:00
..
adr 初始化 2026-09-07 18:24:55 +08:00
AGENTSCOPE_BASELINE.md 初始化 2026-09-07 18:24:55 +08:00
AI_WRITING_BACKEND_DEV_ZH.md 初始化 2026-09-07 18:24:55 +08:00
API.md 初始化 2026-09-07 18:24:55 +08:00
APPLE_CONTAINER.md 初始化 2026-09-07 18:24:55 +08:00
ARCHITECTURE.md 初始化 2026-09-07 18:24:55 +08:00
AUTH_LOGIN.md 初始化 2026-09-07 18:24:55 +08:00
AUTH_TEST_DOCKER_GAP.md 初始化 2026-09-07 18:24:55 +08:00
AUTH_TEST_PLAN.md 初始化 2026-09-07 18:24:55 +08:00
AUTH_UPGRADE.md 初始化 2026-09-07 18:24:55 +08:00
AUTO_TITLE_GENERATION.md 初始化 2026-09-07 18:24:55 +08:00
BACKEND_RUN_STOP_ZH.md 初始化 2026-09-07 18:24:55 +08:00
CONFIGURATION.md 初始化 2026-09-07 18:24:55 +08:00
EXTERNAL_CHAT_SESSION_API_ZH.md 初始化 2026-09-07 18:24:55 +08:00
FILE_UPLOAD.md 初始化 2026-09-07 18:24:55 +08:00
GUARDRAILS.md 初始化 2026-09-07 18:24:55 +08:00
HINDSIGHT_SETUP_ZH.md 初始化 2026-09-07 18:24:55 +08:00
houduankai.md 初始化 2026-09-07 18:24:55 +08:00
LLMWIKI_DEERFLOW_LOCAL_VECTOR_INDEX_ZH.md 初始化 2026-09-07 18:24:55 +08:00
LLMWIKI_WEKNORA_INTEGRATION_ZH.md 初始化 2026-09-07 18:24:55 +08:00
MCP_SERVER.md 初始化 2026-09-07 18:24:55 +08:00
MEMORY_IMPROVEMENTS_SUMMARY.md 初始化 2026-09-07 18:24:55 +08:00
MEMORY_IMPROVEMENTS.md 初始化 2026-09-07 18:24:55 +08:00
MEMORY_SETTINGS_REVIEW.md 初始化 2026-09-07 18:24:55 +08:00
MEMORY_V2_DESIGN_ZH.md 初始化 2026-09-07 18:24:55 +08:00
memory-settings-sample.json 初始化 2026-09-07 18:24:55 +08:00
middleware-execution-flow.md 初始化 2026-09-07 18:24:55 +08:00
PATH_EXAMPLES.md 初始化 2026-09-07 18:24:55 +08:00
plan_mode_usage.md 初始化 2026-09-07 18:24:55 +08:00
PUBLIC_SCHEDULED_TASKS_API.md 初始化 2026-09-07 18:24:55 +08:00
README.md 初始化 2026-09-07 18:24:55 +08:00
rfc-create-deerflow-agent.md 初始化 2026-09-07 18:24:55 +08:00
rfc-extract-shared-modules.md 初始化 2026-09-07 18:24:55 +08:00
rfc-grep-glob-tools.md 初始化 2026-09-07 18:24:55 +08:00
SCHEDULED_TASK_CHANGE_AND_RELEASE_ZH.md 初始化 2026-09-07 18:24:55 +08:00
SETUP.md 初始化 2026-09-07 18:24:55 +08:00
SKILL_EVOLUTION_ZH.md 初始化 2026-09-07 18:24:55 +08:00
STREAMING.md 初始化 2026-09-07 18:24:55 +08:00
summarization.md 初始化 2026-09-07 18:24:55 +08:00
task_tool_improvements.md 初始化 2026-09-07 18:24:55 +08:00
TITLE_GENERATION_IMPLEMENTATION.md 初始化 2026-09-07 18:24:55 +08:00
TODO.md 初始化 2026-09-07 18:24:55 +08:00
WORKFLOW_CONVERSATIONAL_MULTI_AGENT_ORCHESTRATION_ZH.md 初始化 2026-09-07 18:24:55 +08:00
WORKFLOW_OPENAPI_DRAFT_V1.yaml 初始化 2026-09-07 18:24:55 +08:00
WORKFLOW_SCHEMA_V1_ZH.md 初始化 2026-09-07 18:24:55 +08:00
WORKFLOW_SSE_V1_ZH.md 初始化 2026-09-07 18:24:55 +08:00
WORKFLOW_STUDIO_BACKEND_DEV_ZH.md 初始化 2026-09-07 18:24:55 +08:00
WORKFLOW_STUDIO_BACKEND_REMEDIATION_ZH.md 初始化 2026-09-07 18:24:55 +08:00
WORKFLOW_STUDIO_COZE_FRONTEND_ADAPTATION_ZH.md 初始化 2026-09-07 18:24:55 +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

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