mirror of https://github.com/bytedance/deer-flow.git synced 2026-11-15 15:50:35 +00:00

History

fix(workspace): treat hidden output paths as working state (#8254 )

* fix(workspace): treat hidden output paths as working state

get_changed_output_paths counted every regular file under outputs as a
produced artifact, so a finished run that left a cursor/state JSON or a .work/
scratch tree there was recorded as delivery incomplete. Skip paths with a
hidden segment below outputs; visible files still count. Part of #8239.

* fix(workspace): share the outputs prefix and document the hidden-path rule

The delivery filter partitioned on a hardcoded /outputs/ while the scanner
built the same prefix in recorder.py, so a future prefix change would silently
stop filtering working state. Export one OUTPUTS_VIRTUAL_PREFIX used by both,
and record the hidden-path exclusion in the runtime guidance contract.

2026-11-15 21:01:09 +08:00

API.md

fix(gateway): match conversation reference URLs on the addressed host (#8216 )

2026-11-14 22:17:14 +08:00

APPLE_CONTAINER.md

fix(make): name what make clean deletes and refuse under a live gateway (#6351 )

2026-10-06 15:32:46 +08:00

ARCHITECTURE.md

feat(projects): add visible project memory with extraction controls (#8117 )

2026-11-12 09:09:44 +08:00

AUTH_DESIGN.md

fix(auth): key the compose login lockout by client, not by nginx (#6519 )

2026-10-09 17:22:45 +08:00

AUTH_TEST_DOCKER_GAP.md

docs: clean gateway runtime transition remnants (#3334 )

2026-06-02 10:03:28 +08:00

AUTH_TEST_PLAN.md

docs(auth): describe IM channel user buckets accurately (#7730 )

2026-10-31 07:21:57 +08:00

AUTH_UPGRADE.md

docs(auth): describe IM channel user buckets accurately (#7730 )

2026-10-31 07:21:57 +08:00

AUTO_TITLE_GENERATION.md

fix(title): avoid default LLM call before stream end (#3885 )

2026-06-30 18:58:02 +08:00

BATCH_CONTINUATION.md

feat(subagents): continue requested batch work and schedule explicit prerequisites (#7839 )

2026-11-05 15:10:21 +08:00

blob-storage.md

fix(artifacts): authorize shared image reads and offload MIME lookup (#7604 )

2026-10-27 16:59:19 +08:00

BLOCKING_IO_DETECTION.md

feat(skill): add blocking-io-guard — SOP skill for blocking-IO triage and runtime anchors (#3503 )

2026-06-12 10:20:38 +08:00

checkpoint-retention-contract.md

fix(checkpoints): run conservative retention after completion (#6051 )

2026-10-20 22:23:47 +08:00

CONFIGURATION.md

fix(web-fetch): stop sending .env.example placeholder keys to providers (#8206 )

2026-11-13 23:23:29 +08:00

extension-agent-runs.md

feat(workflows): add Phase 2 approvals, immutable artifacts and configuration evidence (#6920 )

2026-10-17 09:41:15 +08:00

extension-model-invocation.md

feat(extensions): grant bounded host model invocation (#5796 )

2026-09-25 15:24:09 +08:00

FILE_UPLOAD.md

fix(uploads): retain filesystem ownership across request cancellation (#7170 )

2026-10-20 23:17:00 +08:00

GITHUB_AGENTS.md

fix(github): build the App JWT off the loop and reuse the parsed key (#8203 )

2026-11-13 14:31:29 +08:00

GUARDRAILS.md

feat(decisions): add an OpenAI Decisions backend for the decision slots (#7127 )

2026-10-20 11:50:46 +08:00

IM_CHANNEL_CONNECTIONS.md

feat(goal): add /goal from-chat for IM channels (#8200 )

2026-11-13 14:22:58 +08:00

KNOWLEDGE.md

feat(weknora): allow opt-in shared retrieval for authenticated users (#7944 )

2026-11-09 17:06:05 +08:00

LOOP_DETECTION.md

fix(agents): isolate loop detection state by run (#5344 )

2026-09-11 13:45:52 +08:00

MCP_SERVER.md

feat(mcp): bind HTTP tool credentials to approved custom agents (#8242 )

2026-11-14 22:10:33 +08:00

mcp-control-leases.md

fix(mcp): retain durable control claims through slow calls and cancellation (#6780 )

2026-10-21 22:03:21 +08:00

MEMORY_COGNITIVE_STYLE.md

feat(memory): add cognitiveStyle for collaboration preferences (#3182 )

2026-09-23 18:29:12 +08:00

MEMORY_IMPROVEMENTS_SUMMARY.md

doc(backend): Fixes the links of the backend documents (#5764 )

2026-09-23 15:24:13 +08:00

MEMORY_IMPROVEMENTS.md

feat(memory): add Jev pre-screening and signal classification over a shared TypeSafe client (#5906 )

2026-09-27 20:28:05 +08:00

MEMORY_SETTINGS_REVIEW.md

fix(memory): keep sample import backups unique per run (#7418 )

2026-10-24 21:50:27 +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

perf(middleware): stop checkpointing view_image base64 payloads (#5014 )

2026-08-27 09:12:37 +08:00

PATH_EXAMPLES.md

docs(backend): drop references to APIs that do not exist (#5798 )

2026-09-25 14:15:59 +08:00

plan_mode_usage.md

doc(backend): Fixes the links of the backend documents (#5764 )

2026-09-23 15:24:13 +08:00

README.md

feat(runtime): publish owner-confirmed run.terminal evidence (#7134 )

2026-10-25 00:12:26 +08:00

REPLAY_E2E.md

refactor(agent): ground runtime decisions in structured evidence (#7986 )

2026-11-08 22:00:23 +08:00

rfc-create-deerflow-agent.md

feat(subagents): add unified capacity and durable batch execution (#4998 )

2026-08-25 07:49:38 +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

RUN_EVENT_STREAM.md

fix(runtime): backfill run.terminal after confirmed recovery takeover (#7500 )

2026-10-25 23:22:02 +08:00

RUN_INTERACTION_POLICY.md

feat(approvals): add Ask, Auto and Full tool permission modes (#8033 )

2026-11-11 20:59:05 +08:00

runtime-guidance-details.md

fix(workspace): treat hidden output paths as working state (#8254 )

2026-11-15 21:01:09 +08:00

SANDBOX_MEMORY_PROFILING.md

chore: add sandbox memory profiling tools (#3249 )

2026-06-03 22:02:27 +08:00

SETUP.md

docs: run configuration and migration commands in the backend environment (#6425 )

2026-10-07 19:06:59 +08:00

SSO.md

fix(auth): map malformed OIDC provider bodies to OIDCError (#7258 )

2026-10-22 19:35:43 +08:00

STREAMING.md

fix(streaming): isolate in-memory replay payloads (#7644 )

2026-10-31 08:15:24 +08:00

summarization.md

feat(summarization): align built-in compaction prompt to preserve user requirements and approval conditions (#8114 ) (#8114 )

2026-11-11 19:36:32 +08:00

task_tool_improvements.md

refactor: split backend into harness (deerflow.*) and app (app.*) (#1131 )

2026-03-14 22:55:52 +08:00

THREAD_LIFECYCLE.md

feat(chats): add archive and restore (#5236 )

2026-09-06 22:30:26 +08:00

TITLE_GENERATION_IMPLEMENTATION.md

doc(backend): Fixes the links of the backend documents (#5764 )

2026-09-23 15:24:13 +08:00

TODO.md

docs: clean standalone LangGraph server remnants (#3301 )

2026-05-29 11:36:45 +08:00

TUI.md

feat(goal): add /goal from-chat for IM channels (#8200 )

2026-11-13 14:22:58 +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
AUTH_DESIGN.md	User authentication, CSRF, platform-trust (IM / Internal Auth), and per-user isolation
SSO.md	OIDC / SSO single sign-on
IM_CHANNEL_CONNECTIONS.md	IM channel user binding (`channel_connections`)
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
RUN_EVENT_STREAM.md	Persisted run event stream: contract, terminal authority, evidence ordering, and known gaps
FILE_UPLOAD.md	File upload functionality
PATH_EXAMPLES.md	Path types and usage examples
SANDBOX_MEMORY_PROFILING.md	Sandbox memory baseline and runtime comparison guide
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
├── RUN_EVENT_STREAM.md        # Persisted run event stream contract
├── AUTO_TITLE_GENERATION.md   # Title generation
├── TITLE_GENERATION_IMPLEMENTATION.md  # Title implementation details
└── TODO.md                    # Roadmap and issues