Repository navigation
README: rewrite for use-cases, less technical dump #1351
Description
Why
Owner direction (FlyBot room, 2026-10-27): the current root README has too much technical stuff. Readers need what it is for and how to use it, not an architecture / plugin dump.
Scope
Update README.md and keep README.zh.md in sync.
Do
- Lead with purpose and everyday use (tree team, friends/social, optional timeline; mention group chat / boards / workflows only at a product level if they ship on main).
- Keep Quick Start short: prerequisites, install, run, optional Bot Social pointer.
- Refresh version pins / badges if they are stale (today they still show DSH
0.2.0-rc.2while the product is past that). - Prefer demos and short bullets over deep tool/limit/middleware prose.
Do not
- Turn the README into an architecture or contributing guide (those stay in
docs/,AGENTS.md,CONTRIBUTING.md). - Bundle #775 (WeChat QR) unless the owner supplies the image separately.
- Change product code — docs only.
Acceptance
- A new visitor can tell what FlyBot is for and how to try it in a few minutes of reading.
- EN/ZH stay aligned; install commands and badges match what the repo currently recommends.
- No large technical digressions that belong in subsystem docs.
Out of room scope
The FlyBot Grok room is not implementing this tip; filing the issue is enough for now.
Activity
hsliuustc0106 commentedon Oct 27, 2026
Style reference (owner, 2026-10-27)
Learn from yetone/magpie README — not the product, the shape:
docs/, reference) — root README stays a landing page.Acceptance add-on: a stranger skimming the first screen should get why FlyBot and how to try it without reading plugin internals. EN/ZH stay aligned.
Birfy commentedon Oct 27, 2026
Triage（2026-10-27T07:44Z，main
ed89efc4）查重：无重复。 全仓 open issue 按 README 搜，只命中
#775（加社区微信群二维码）；本单正文明确「不捆绑#775」，两张不冲突、不合并。判定：可动，打
agent-ready（docs-only，不改产品代码；Acceptance 已足够清楚，风格参照hsliuustc0106那条评论）。一处范围更正，实现时按这个来：正文「Refresh version pins … 现在还写 DSH
0.2.0-rc.2，而产品已经超过它」——实测两处并不矛盾。README.md:15、:60、:98、:122-124、:132里的0.2.0-rc.2是 DeepSeek Harness（npx @deepseek-ai/dsh）的版本，而仓库自己钉的就是这个版本：core/dev/harness/package.json:6与ds-bot/dev/harness/package.json:6都是"@deepseek-ai/dsh": "0.2.0-rc.2"。所以 README 与 pin 一致，不是「忘了改」。dev/harness的 pin 对齐」；其余边界照正文：EN/ZH 同步、不碰
#775的二维码、不写成架构/贡献指南。标签documentation+area:docs已够，这里只加agent-ready。Rewrite the README for what people do with FlyBot
Birfy commentedon Oct 27, 2026
Written-by: Dev4
Claimed #1351 — branch
dev4/1351-readme, PR #1385 (README.md+README.zh.md, +197/−224). First step: the EN rewrite led by the product and the three demos, then the ZH twin against it.Followed both notes on this issue: the owner's magpie-style shape (one-line value prop → Is this for you? → demos → 3-step quick start → depth in
docs/), and Triage's scope correction — the DSH version is not bumped, the README keeps the same0.2.0-rc.2thatdev/harnesspins. The bump itself is #1384.Rewrite the README for what people do with FlyBot (ThinkFlowLab#1385)