mirror of
https://github.com/bytedance/deer-flow.git
synced 2026-07-10 00:18:36 +00:00
9f3be2a9fa
Some checks are pending
Backend Blocking IO / backend-blocking-io (push) Waiting to run
Unit Tests / backend-unit-tests (push) Waiting to run
Frontend Unit Tests / frontend-unit-tests (push) Waiting to run
Lint Check / lint (push) Waiting to run
Lint Check / lint-frontend (push) Waiting to run
UploadsMiddleware defines only the sync `before_agent` hook. LangChain wires a sync-only hook as `RunnableCallable(before_agent, None)`, and LangGraph's `ainvoke` runs it directly on the event loop when `afunc is None` — so the per-message uploads-directory scan (`exists`/`iterdir`/`stat` plus reading sibling `.md` outlines) blocks the asyncio event loop on every message that has an uploads directory. Add `abefore_agent` that offloads the scan to a worker thread via `run_in_executor`; it copies the current context, preserving the `user_id` contextvar read by `get_effective_user_id()`. Add a runtime anchor under `tests/blocking_io/` that drives the real `create_agent` graph via `ainvoke` under the strict Blockbuster gate, so a regression back onto the event loop fails CI. Update blocking-IO docs. |
||
|---|---|---|
| .. | ||
| API.md | ||
| APPLE_CONTAINER.md | ||
| ARCHITECTURE.md | ||
| AUTH_DESIGN.md | ||
| AUTH_TEST_DOCKER_GAP.md | ||
| AUTH_TEST_PLAN.md | ||
| AUTH_UPGRADE.md | ||
| AUTO_TITLE_GENERATION.md | ||
| BLOCKING_IO_DETECTION.md | ||
| CONFIGURATION.md | ||
| FILE_UPLOAD.md | ||
| GUARDRAILS.md | ||
| MCP_SERVER.md | ||
| memory-settings-sample.json | ||
| MEMORY_IMPROVEMENTS.md | ||
| MEMORY_IMPROVEMENTS_SUMMARY.md | ||
| MEMORY_SETTINGS_REVIEW.md | ||
| middleware-execution-flow.md | ||
| PATH_EXAMPLES.md | ||
| plan_mode_usage.md | ||
| README.md | ||
| rfc-create-deerflow-agent.md | ||
| rfc-extract-shared-modules.md | ||
| rfc-grep-glob-tools.md | ||
| SETUP.md | ||
| STREAMING.md | ||
| summarization.md | ||
| task_tool_improvements.md | ||
| TITLE_GENERATION_IMPLEMENTATION.md | ||
| TODO.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 |
| AUTH_DESIGN.md | User authentication, CSRF, and per-user isolation design |
| 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
├── AUTH_DESIGN.md # User authentication and isolation design
├── 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