From 01aeab32ca626c52b6f0611ad1d147653d114652 Mon Sep 17 00:00:00 2001 From: Danyang Chen Date: Wed, 11 Nov 2026 15:43:22 +0800 Subject: [PATCH] docs: name the @flybot/project plugin in the READMEs and the indexes The Project plugin ships as @flybot/project but the root READMEs and the two index pages still describe only the other five peer plugins. - README.md and README.zh.md: one Project bullet in the feature list, between Workflows and Timeline. - docs/architecture.md: one plugins/project/ row in the layout table. - docs/subsystems/README.md: one project row in the subsystem index. Docs only; no code, tests or changelog fragment. --- README.md | 4 ++++ README.zh.md | 3 +++ docs/architecture.md | 1 + docs/subsystems/README.md | 1 + 4 files changed, 9 insertions(+) diff --git a/README.md b/README.md index 356fafa4a..d35d2a150 100644 --- a/README.md +++ b/README.md @@ -88,6 +88,10 @@ here, so Bot lines post without a hold. Some waiting is sped up.* - **Workflows** (`@flybot/workflow`). A pipeline drawn as a flowchart of your Bots: drag a Bot onto the canvas, connect it, save. A run walks the graph and posts its progress in the Workflow chat. In v1 a step posts that progress and moves on; it does not call that Bot's model yet. +- **Project** (`@flybot/project`). Project State (the files the day's work is written in), a board of cards by column, a + Chief that runs that Project, a team dossier and metrics, and an assistant that answers only from the Project's own + records. The core keeps the record and the `project-*` endpoints; the domain is this plugin, switched in Settings like + the others. - **Schedules.** A Bot wakes at a fixed time to do one job, then sleeps again. - **Connectors.** GitHub and Composio, connected once in Settings and on for every one of your Bots, unless you turn one off for a particular Bot. diff --git a/README.zh.md b/README.zh.md index ac1b5c534..17a6ac32c 100644 --- a/README.zh.md +++ b/README.zh.md @@ -76,6 +76,9 @@ FlyBot 是一个直接跑起来的应用，建在 DeepSeek Harness 之上。 - **群聊。** 你和几个 Bot 在同一个房间；房间的看板决定谁做什么，普通一句话由合适的那位回答。 - **工作流**（`@flybot/workflow`）。把流水线画成一张 Bot 流程图：拖一个 Bot 上画布、连线、保存。运行时沿着图 走，把进度发在 Workflow 聊天里。v1 的一步只发这条进度就往下走，还不会调用那个 Bot 的模型。 +- **项目**（`@flybot/project`）。一个项目一份记录：Project State（当天工作写进哪几个文件）、按列分卡的看板、 + 负责推进这个项目的 Chief、团队档案与指标，以及只按这个项目自己的记录回答的助理。core 保留项目记录与 + `project-*` 端点，领域逻辑在这个插件里，开关和其它插件一样在设置里。 - **定时任务。** Bot 到点醒来做一件事，做完再睡。 - **连接器。** GitHub 与 Composio，在设置里连一次，你的每个 Bot 都能用；也可以单独给某个 Bot 关掉。 - **时间线**（`@flybot/timeline`，可选，默认关闭）。每个 Bot 一条泳道、谁在等谁、各自多忙。只存 id、时间和 diff --git a/docs/architecture.md b/docs/architecture.md index a9bdb9ce6..4f7bc3b08 100644 --- a/docs/architecture.md +++ b/docs/architecture.md @@ -13,6 +13,7 @@ FlyBot is a team of long-lived Bots built on DeepSeek Harness (DSH). Two parts s | `plugins/tree/` | `@flybot/tree` — knowledge-tree plugin. | | `plugins/timeline/` | `@flybot/timeline` — where time goes across the local Bot team (swimlanes, communication map, utilization). | | `plugins/workflow/` | `@flybot/workflow` — a group-shaped chat of local Bots, with a flowchart and task assignment. | +| `plugins/project/` | `@flybot/project` — the Project domain: Project State, its board, the Project's own Chief, the team dossier, metrics and the assistant. | | `app/` | Desktop app (Windows/macOS) for the DSH + plugin. | ## Subsystems diff --git a/docs/subsystems/README.md b/docs/subsystems/README.md index 50340d57a..f30e1b20c 100644 --- a/docs/subsystems/README.md +++ b/docs/subsystems/README.md @@ -11,6 +11,7 @@ Detail pages for each FlyBot subsystem. Each page lists `owned_paths`, what the | tree | [tree.md](tree.md) | `plugins/tree/` | | timeline | [timeline.md](timeline.md) | `plugins/timeline/` | | workflow | [workflow.md](workflow.md) | `plugins/workflow/` | +| project | [project.md](project.md) | `plugins/project/` | | social | [social.md](social.md) | `plugins/social/` | | install | [install.md](install.md) | `core/scripts/`, arch-doc tests, `plugins/README.md`, the container image (`Dockerfile`, `compose.yaml`, `docker/`) | | team | [team.md](team.md) | `docs/subsystems/team.md` — **planned contract only** (no code paths; multi-human is not shipped) |