diff --git a/README.md b/README.md index 9d88e41..1155454 100644 --- a/README.md +++ b/README.md @@ -1,42 +1,42 @@ # dsh-superagent -> **Research prototype for reference only, not an official DeepSeek product.** This code grew out of our team's day-to-day development work, with much of the engineering done by coding agents. Treat it as research code, not production-ready software. It may still contain bugs, and its coding style and engineering practices may be inconsistent. Review and adapt it before using it in your own environment. +> **仅供研究参考的原型，不是 DeepSeek 官方产品。** 这份代码长自我们团队的日常开发工作，相当一部分工程由编码 agent 完成。请把它当作研究代码，不是可直接上生产的软件。它可能还有 bug，编码风格和工程实践也可能不一致。在自己的环境里用之前，先审查并按需适配。 > -> We have adapted it for publication, so it is not identical to our internal version or the implementation described in *Exploring Super-agent Design: Towards a More Autonomous Agent System*. Some designs discussed in the article are directions for future development and are not implemented in this prototype. +> 为了发布我们做了适配，所以它与我们内部版本、以及 *Exploring Super-agent Design: Towards a More Autonomous Agent System* 一文所描述的实现并不完全相同。文章里讨论的一些设计是未来开发方向，本原型未实现。 -dsh-superagent is a proactive coding agent for one GitHub repository, packaged as a bundle for [DeepSeek Harness](https://www.deepseek.com/en/harness/). It listens to GitHub and, optionally, Feishu. When someone allowed asks the agent for work, it opens a work item, works on it in its own agent session and directory, and answers in the original conversation, for example with a pull request. A web panel shows what needs a person. +dsh-superagent 是为一个 GitHub 仓库服务的主动式编码 agent，打包成 [DeepSeek Harness](https://www.deepseek.com/en/harness/) 的 bundle。它监听 GitHub，可选地也监听飞书。当允许名单里的人向 agent 要活儿时，它开一个工单，在自己独立的 agent 会话和目录里干活，并在原对话里答复——比如提一个 pull request。Web 面板显示哪些事需要人。 -It is also a way of working with an agent: **take as little human attention as possible, and give as much value as possible.** An agent that can act for a whole team can also waste a whole team's attention, so it acts only when asked or when a rule the team wrote allows it, and speaks only when someone must act or can use a result. [docs/000-philosophy.md](docs/000-philosophy.md) explains the principle and what it asks of the operator. +它也是一种与 agent 协作的方式：**尽量少的占用人的注意力，尽量多的交付价值。** 一个能替整个团队行动的 agent 也能浪费整个团队的注意力，所以它只在被要求、或被团队自己写下的规则允许时才行动，只在有人必须行动、或能用上结果时才说话。[docs/000-philosophy.md](docs/000-philosophy.md) 解释这个原则以及它对操作者的要求。 -## Setup +## 安装 -Setup has many steps, so an agent does it with you. Ask your coding agent: +安装步骤较多，所以由一个 agent 陪你做。对你的编码 agent 说： -> Read SETUP.md in this repository and set up dsh-superagent with me. +> 读这个仓库里的 SETUP.md，陪我一起把 dsh-superagent 装好。 -It asks one short question at a time, shows the full plan once, and then installs and configures everything. [SETUP.md](SETUP.md) is what it follows. +它会一次只问一个短问题，展示一次完整计划，然后安装并配置好一切。[SETUP.md](SETUP.md) 就是它遵循的协议。 -For this fork there is also a hands-on Chinese quickstart covering plugin installation, the Gitea Source and model providers: [INSTALL.md](INSTALL.md). The English reference remains [docs/006-deployment.md](docs/006-deployment.md). +本 fork 另有一篇动手向的中文速查，覆盖插件安装、Gitea Source 与模型 provider：[INSTALL.md](INSTALL.md)。英文参考仍是 [docs/006-deployment.md](docs/006-deployment.md)。 -## Documentation +## 文档 -Read the numbered documents in order; each builds only on the ones before it. +按编号顺序读；每篇只建立在前几篇之上。 -- [000 Philosophy](docs/000-philosophy.md) -- [001 Domain model](docs/001-domain.md) -- [002 Authorization](docs/002-authorization.md) -- [003 Execution](docs/003-execution.md) -- [004 Prompts](docs/004-prompts.md) -- [005 Panel](docs/005-panel.md) -- [006 Deployment](docs/006-deployment.md): manual setup, configuration, upgrades and troubleshooting -- [007 Architecture](docs/007-architecture.md) -- [008 Cookbook](docs/008-cookbook.md): adding a Source +- [000 理念](docs/000-philosophy.md) +- [001 领域模型](docs/001-domain.md) +- [002 授权](docs/002-authorization.md) +- [003 执行](docs/003-execution.md) +- [004 提示词](docs/004-prompts.md) +- [005 面板](docs/005-panel.md) +- [006 部署](docs/006-deployment.md)：手工安装、配置、升级与排障 +- [007 架构](docs/007-architecture.md) +- [008 手册](docs/008-cookbook.md)：加一个 Source -## Development +## 开发 -`pnpm check` runs the typecheck, the tests and the build. +`pnpm check` 跑类型检查、测试和构建。 -## License +## 许可证 [MIT](LICENSE)