Luo-root/PRism · opened by Luo-root
本次 PR 为项目补充了三项基础设施文档：API 接口文档（docs/api.md）、系统架构文档（docs/architecture.md）和 Apache 2.0 许可证文件（LICENSE）。同时在 README.md 中同步更新了项目信息，并清理了 go.mod 中未使用的间接依赖。整体变更以文档新增为主，不影响运行时代码逻辑。
Go 官方发布版本中没有 1.26.3，目前最新稳定版本为 1.24.x。README 的环境要求和顶部徽章均引用了这个不存在的版本号（行 18 徽章 `Go-1.26.3`、行 106 要求 `Go 1.26.3+`），会误导开发者安装错误版本。建议更新为项目实际要求的最低版本（如 1.23），并同步修改徽章。
# 环境要求
- **Go** 1.26.3+
# 徽章
[](https://go.dev/)# 环境要求
- **Go** 1.23+
# 徽章
[](https://go.dev/)环境变量 `FEISHU_WEBHOOKS` 的格式描述为 `名称|URL|密钥;...`，但示例中第一个条目 `群名1|https://.../xxx` 缺少签名密钥部分，只有第二个条目包含 `|签名密钥`。用户可能据此配置不完整的 webhook，导致签名验证失败。示例应为每个条目都包含完整的三段式结构。
FEISHU_WEBHOOKS=群名1|https://open.feishu.cn/open-apis/bot/v2/hook/xxx;群名2|https://open.feishu.cn/open-apis/bot/v2/hook/xxx|签名密钥FEISHU_WEBHOOKS=群名1|https://open.feishu.cn/open-apis/bot/v2/hook/xxx|签名密钥1;群名2|https://open.feishu.cn/open-apis/bot/v2/hook/xxx|签名密钥2添加 Apache 2.0 许可证是正确操作，但标准的 Apache 2.0 许可证通常附带 APPENDIX 部分，指导使用者如何将许可证应用到自己的项目中。更关键的是，文件中没有包含项目的版权持有人信息（如 `Copyright [yyyy] [name of copyright owner]`），这是许可证的核心要素之一。没有版权信息，许可证的法律效力可能不完整。建议在文件末尾添加 APPENDIX 和版权声明。
... limitations under the License.
（文件结束，无 APPENDIX 和版权信息）... limitations under the License.
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.文档的起始行是 `package docs`，这是 Go 语言的包声明，不应出现在 Markdown 文档中。可能是从代码文件自动生成文档时未清理干净。这会导致文档渲染后第一行显示为无意义的代码文本，影响阅读体验和专业度。应直接以 Markdown 标题 `# PRism 架构文档` 开头。
package docs
# PRism 架构文档# PRism 架构文档在第 15 行附近的 ASCII 架构图中出现了一个无效字符（`�`，即 Unicode 替换字符 U+FFFD），通常是复制粘贴或编码转换时引入的。同时，Diff 显示代码块在该字符处被截断（`... [truncated]`），整个架构图没有闭合的边框。这会导致文档渲染时架构图显示不完整、出现乱码。需要修复无效字符并补全架构图的完整内容。
│ ▼ ▼ │ �
... [truncated]│ ▼ ▼ │ │
│ │ │ │ │
│ ▼ ▼ │ │
└──────────────────────────────────────────────────────────┘ │徽章链接使用相对路径 `[LICENSE](LICENSE)`，在 GitHub 仓库首页可以正常工作，但当 README 被其他站点引用（如 pkg.go.dev、npm 等）或在子目录查看时，相对路径会解析失败。建议使用 GitHub 绝对路径以确保通用性。注意：此为低置信度建议，因为本项目是 GitHub 仓库，相对路径在主场景下完全可用。
[](LICENSE)[](https://github.com/Luo-root/PRism/blob/master/LICENSE)从第 36 行开始的大型 ASCII 架构图代码块使用了裸的 ``` 分隔符，没有指定语言标记（如 ```text）。虽然不影响内容渲染，但部分 Markdown 渲染器（如 VS Code 预览）会因缺少语言标记而无法正确处理等宽字体对齐，可能导致架构图错位。建议添加 `text` 标记。
```
┌──────────────────────────────────────────────────────────────────┐
│ 接入层 (Gin HTTP) │```text
┌──────────────────────────────────────────────────────────────────┐
│ 接入层 (Gin HTTP) │从第 36 行开始的架构图代码块包含了非常详细的数百行 ASCII 图表。虽然详细视图有价值，但在文档正文中如此长的代码块会降低整体可读性。可以考虑在正文保留简化的高层级流程图，将详细架构图移至附录或独立文件中。这是一个可选的可读性优化建议。
（整段代码块包含数百行 ASCII 图表）// 正文中使用简化版
```text
[接入层 Gin] → [调度层] → [审查队列 WorkerQueue]
→ [工作线程] → [上下文获取] → [模型选择] → [审查执行] → [报告生成]
```
// 详细版移至 docs/architecture-detail.md 或附录