66 lines
2.8 KiB
Markdown
66 lines
2.8 KiB
Markdown
# Documentation
|
||
|
||
This directory contains detailed documentation for the DeerFlow backend.
|
||
|
||
## Quick Links
|
||
|
||
| Document | Description |
|
||
|----------|-------------|
|
||
| [ARCHITECTURE.md](ARCHITECTURE.md) | System architecture overview |
|
||
| [API.md](API.md) | Complete API reference |
|
||
| [CONFIGURATION.md](CONFIGURATION.md) | Configuration options |
|
||
| [SETUP.md](SETUP.md) | Quick setup guide |
|
||
|
||
## Feature Documentation
|
||
|
||
| Document | Description |
|
||
|----------|-------------|
|
||
| [STREAMING.md](STREAMING.md) | Token-level streaming design: Gateway vs DeerFlowClient paths, `stream_mode` semantics, per-id dedup |
|
||
| [FILE_UPLOAD.md](FILE_UPLOAD.md) | File upload functionality |
|
||
| [PATH_EXAMPLES.md](PATH_EXAMPLES.md) | Path types and usage examples |
|
||
| [summarization.md](summarization.md) | Context summarization feature |
|
||
| [plan_mode_usage.md](plan_mode_usage.md) | Plan mode with TodoList |
|
||
| [AUTO_TITLE_GENERATION.md](AUTO_TITLE_GENERATION.md) | Automatic title generation |
|
||
|
||
## Workflow Studio
|
||
|
||
| Document | Description |
|
||
|----------|-------------|
|
||
| [WORKFLOW_STUDIO_BACKEND_DEV_ZH.md](WORKFLOW_STUDIO_BACKEND_DEV_ZH.md) | 后端开发基线方案 + 各阶段完成状态 |
|
||
| [adr/0001-workflow-studio-runtime.md](adr/0001-workflow-studio-runtime.md) | ADR：Coze 只做画布 / ChatDev 只作参考 / 自建 DAG 调度器（LangGraph 仅作智能体内核） |
|
||
| [WORKFLOW_SCHEMA_V1_ZH.md](WORKFLOW_SCHEMA_V1_ZH.md) | 内部图 Schema v1.0 |
|
||
| [WORKFLOW_SSE_V1_ZH.md](WORKFLOW_SSE_V1_ZH.md) | SSE 事件协议 v1.0 |
|
||
| [WORKFLOW_OPENAPI_DRAFT_V1.yaml](WORKFLOW_OPENAPI_DRAFT_V1.yaml) | 接口 OpenAPI 草案 |
|
||
|
||
## Development
|
||
|
||
| Document | Description |
|
||
|----------|-------------|
|
||
| [TODO.md](TODO.md) | Planned features and known issues |
|
||
|
||
## Getting Started
|
||
|
||
1. **New to DeerFlow?** Start with [SETUP.md](SETUP.md) for quick installation
|
||
2. **Configuring the system?** See [CONFIGURATION.md](CONFIGURATION.md)
|
||
3. **Understanding the architecture?** Read [ARCHITECTURE.md](ARCHITECTURE.md)
|
||
4. **Building integrations?** Check [API.md](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
|
||
```
|