Visitar URL original
AICodeReviewer/docs/README.md at main · atframework/AICodeReviewer · GitHub
Skip to content

Latest commit

 

History

History
47 lines (37 loc) · 4.09 KB

README.md

File metadata and controls

47 lines (37 loc) · 4.09 KB

文档目录

本目录集中保存设计、用户说明和交付记录。按下面的入口阅读当前文档; 前瞻扩展与外部验收边界见 AI 维护导航。

用户文档

公开用户文档的源码位于 site/src/content/docs/,中文与英文同步维护。

主题 中文 English
安装与首次运行 快速开始 Quick start
配置与多工程 Workspace 配置总览 Configuration overview
配置管理、暂存、预览与版本恢复 管理面板 Dashboard
数据库、缓存与升级 存储 Storage
路由与输出 输出配置 Outputs
Slack 接入指南 Slack
Discord 接入指南 Discord
Telegram 接入指南 Telegram
配置字段 字段参考 Config fields
Workspace 路径变量 模板变量 Template variables
命令与迁移操作 CLI CLI
部署维护 运维 Operations

可运行配置与容器文件位于 example/。 文档站开发、校验和构建方式见 site/README.md。

设计与实现

文档 内容
架构 当前模块边界与稳定约定;Workspace 见 §3.10,存储迁移见 §3.14,来源合并与发布见 §3.15,运行时版本与管理 API 见 §3.16
设计决策 方案取舍;Workspace 与动态配置相关规则见 D37–D47
输出渠道规范 输出渠道、模板、目标选择及发布语义
IM 开发计划 / 集成设计 / 文件成员目录 企业微信应用、通讯录热加载与回调重新评审;进度见计划,接口见实施规范,断言见验收矩阵
Slack、Discord、Telegram 接入 / 执行步骤 / 验收矩阵 Bot API 结果推送与 HTTP 命令;本地及真实平台验收分别记录
评审提示词设计依据 默认评审提示词的目标、约束和参考依据
AI 维护导航 从代码主题定位设计章节、易错点和维护技能

稳定设计继续维护在上述文档中。已完成任务的临时设计、执行计划和测试计划退役后, 不再作为实施入口;历史结论按下面的交付记录追溯。

交付记录与验收边界