文档导航
Wenext-Pi 文档分为使用指南、接口参考和设计说明。配置及命令以当前包实现为准;todo/ 仅描述待实现提案。*-contract.md 文件名保留,便于已有引用继续访问。
使用指南
| 需要完成的事 | 文档 |
|---|---|
| 安装并开始一个任务 | 包 README |
| 配置模型、项目规范、模板和检查 | 配置指南 |
| 安装 Figma、浏览器扩展并配置依赖 | 扩展安装指南 |
| 查找终端命令、交互命令或智能体工具 | 命令参考 |
| 理解简单任务与完整方案的区别 | 任务路由与调试 |
| 恢复会话、保存交接与记忆 | 会话与记忆 |
| 配置上报、连接仪表盘、解释数据 | 指标与上报 |
| 处理启动、授权、检查与观测异常 | 故障排查 |
配置与接口参考
这些文档面向项目维护者、工具集成者和智能体工作流维护者。智能体工具不是 Shell 命令;文档标记为内部的 TypeScript 接口也不构成稳定 npm SDK。
| 主题 | 文档 |
|---|---|
| 方案模板、审查与批准 | 方案审查 |
| 提交任务改动、保护暂存区与归档 | 任务提交 |
| 文件范围、已有改动和归属 | 写入范围 |
| 持续实施、暂停、检查与归档 | 任务执行 |
| 检查声明、公开输入输出、证据 | 质量检查 |
| 启动与检查前的环境命令 | 项目准备 |
| Web 测试工具安装、适用性与报告 | Web 质量插件 |
| 失败重试与保留失败结果归档 | 重试与失败关闭 |
| 子智能体工具、并发与取消 | 只读子智能体 |
| 外置状态、项目身份与旧状态迁移 | 存储与迁移 |
| 认证失败分类与续期策略 | OAuth 适配 |
| 旧接收端协议 | 旧版 v1 接收协议;新接入使用 v2 |
设计与开发
| 主题 | 文档 |
|---|---|
| 系统分层、状态权威与关键链路 | 架构设计 |
| 扩展方式选择、职责边界与限制 | 扩展设计 |
| 内置插件 manifest、服务与生命周期 | 内置插件开发 |
| 本地构建、测试与发布 | 开发指南 |
| 待实现:异构插件指标及通用仪表盘 | 插件观测提案 |
| 待评审:按实际能力选择浏览器与视觉验收路径 | 浏览器能力统一方案 |
实施日志、任务验收记录和发布过程不属于这些文档;设计说明描述职责与约束,使用指南描述用户能够执行的操作。