AGENTFLOW DOCUMENTATION
开发与贡献
了解代码边界、验证流程和文档维护方式。
项目结构
| 目录 | 职责 |
|---|---|
| server.ts / src/ | HTTP 装配、认证、租户运行时、业务与数据访问。 |
| web/src/ | React 工作台、公开网站与浏览器逻辑。 |
| shared/ | 前后端共享类型与纯业务函数。 |
| packages/context-engine | 不可变快照、交付包与完整性校验。 |
| packages/context-adapters | 历史会话、Markdown 与缺陷来源适配。 |
| packages/device-agent | 独立开发机连接器。 |
| migrations/postgres/ | 按编号执行的数据库迁移。 |
本地验证
bash
pnpm install --frozen-lockfile
pnpm typecheck
pnpm test
pnpm test:e2e测试使用独立 PostgreSQL / pgvector 数据库,默认可通过 Docker 自动创建。浏览器测试需要 Chromium;首次可运行 pnpm exec playwright install chromium。连接器安装回归需访问公共 registry。
修改前阅读根目录及目标目录的 AGENTS.md。沿用 TypeScript 严格模式和 ESM .js 相对导入,不跨越共享层、服务端与浏览器边界。修复缺陷时补充能复现行为的测试。
维护官网与公开文档
公开内容位于 web/src/site/content.ts,页面生成位于 web/src/site/render.ts。Vite 在构建时生成独立 HTML,每篇文档具有地址、标题、描述和页内目录。全文搜索在浏览器本地完成。
运行 pnpm build:client 更新产物;不要手工编辑或提交 public/build/。添加文档时同步验证导航、搜索、深链接及手机布局。
提交反馈和改进
在GitHub 仓库提交可复现的问题或 Pull Request,说明触发条件、修改行为和验证证据。安全问题报告应避免公开可利用细节或凭据。
网站信息架构参考Linear 产品页、Linear Docs及n8n 自托管文档,产品能力以本项目实现为准。
发现问题或需要补充?在 GitHub 提交反馈 ↗