github/deer-flow
1
0
Fork 0
mirror of https://github.com/bytedance/deer-flow.git synced 2026-09-10 05:58:36 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: fix architecture guide relative links (#4909)

Browse Source
This commit is contained in:
ChaseMoon 2026-08-19 21:00:38 +08:00 committed by GitHub
parent 62ffcff45b
commit 592b56beac
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
docs/ARCHITECTURE.md
View File

@ -4,11 +4,11 @@ This document is the **top-level architecture overview** for DeerFlow. It explai
"big picture" — how the services, layers, and cross-cutting subsystems fit together — and "big picture" — how the services, layers, and cross-cutting subsystems fit together — and
points to the module-level guides that own the depth: points to the module-level guides that own the depth:
- Backend depth → [`backend/AGENTS.md`](backend/AGENTS.md) and [`backend/docs/ARCHITECTURE.md`](backend/docs/ARCHITECTURE.md) - Backend depth → [`backend/AGENTS.md`](../backend/AGENTS.md) and [`backend/docs/ARCHITECTURE.md`](../backend/docs/ARCHITECTURE.md)
- Frontend depth → [`frontend/AGENTS.md`](frontend/AGENTS.md) - Frontend depth → [`frontend/AGENTS.md`](../frontend/AGENTS.md)
DeerFlow 2.0 is a ground-up rewrite of the original Deep Research framework (see DeerFlow 2.0 is a ground-up rewrite of the original Deep Research framework (see
[`README.md`](README.md)); it shares no code with v1. [`README.md`](../README.md)); it shares no code with v1.
--- ---
@ -160,7 +160,7 @@ These span both layers and require reading multiple files to understand:
- **Version sources** — a release version must match in `backend/pyproject.toml`, - **Version sources** — a release version must match in `backend/pyproject.toml`,
`frontend/package.json`, and `deploy/helm/deer-flow/Chart.yaml` (`version` + `appVersion`); `frontend/package.json`, and `deploy/helm/deer-flow/Chart.yaml` (`version` + `appVersion`);
pushing a `v*` tag triggers CI that runs `scripts/verify_versions.sh` and blocks all pushing a `v*` tag triggers CI that runs `scripts/verify_versions.sh` and blocks all
publishing on drift. See [`RELEASING.md`](RELEASING.md). publishing on drift. See [`RELEASING.md`](../RELEASING.md).
--- ---
@ -174,16 +174,16 @@ These span both layers and require reading multiple files to understand:
resolution; servers toggle independently. resolution; servers toggle independently.
- **Loopback-by-default ingress**: nginx is the only published surface; the Gateway's `8001` - **Loopback-by-default ingress**: nginx is the only published surface; the Gateway's `8001`
is container-internal and never published. A bare `"${PORT}:2026"` bind (0.0.0.0) is is container-internal and never published. A bare `"${PORT}:2026"` bind (0.0.0.0) is
rejected by convention and CI. See the Security Notice in [`README.md`](README.md) before rejected by convention and CI. See the Security Notice in [`README.md`](../README.md) before
any non-loopback deployment. any non-loopback deployment.
--- ---
## 7. Where to Go Next ## 7. Where to Go Next
- System topology & component depth → [`backend/docs/ARCHITECTURE.md`](backend/docs/ARCHITECTURE.md) - System topology & component depth → [`backend/docs/ARCHITECTURE.md`](../backend/docs/ARCHITECTURE.md)
- Backend commands, TDD, harness/app boundary, config reload → [`backend/AGENTS.md`](backend/AGENTS.md) - Backend commands, TDD, harness/app boundary, config reload → [`backend/AGENTS.md`](../backend/AGENTS.md)
- Frontend commands, source layout, streaming data flow → [`frontend/AGENTS.md`](frontend/AGENTS.md) - Frontend commands, source layout, streaming data flow → [`frontend/AGENTS.md`](../frontend/AGENTS.md)
- Setup & install → [`Install.md`](Install.md), [`CONTRIBUTING.md`](CONTRIBUTING.md) - Setup & install → [`Install.md`](../Install.md), [`CONTRIBUTING.md`](../CONTRIBUTING.md)
- Release process → [`RELEASING.md`](RELEASING.md) - Release process → [`RELEASING.md`](../RELEASING.md)
- User-facing features & deployment sizing → [`README.md`](README.md) - User-facing features & deployment sizing → [`README.md`](../README.md)