🌸 Sakura-Bot Wiki
欢迎来到 Sakura-Bot 项目文档中心！这里汇集了所有面向用户和开发者的详细文档。
📚 文档导航
👥 用户文档
面向使用 Sakura-Bot 的用户，包含安装、配置和使用指南。
- 用户文档首页 - 查看所有用户文档
- 快速开始 - 快速部署和开始使用
- 问答 Bot 指南 - 智能问答功能使用指南
- RAG 快速启动 - 语义检索功能快速配置
- 多轮对话功能 - 上下文感知对话说明
- 投票功能 - 频道投票配置指南
- WebUI 管理面板 - Web 管理界面使用指南
- Sakura Guard 智能群管 - 群聊规则与入群验证
- 行为准则 - 社区贡献行为准则
👨💻 开发者文档
面向参与 Sakura-Bot 开发的贡献者，包含架构、实现和开发指南。
- 开发者文档首页 - 查看所有开发者文档
- 开发快速开始 - 开发环境配置
- 架构设计 - 系统架构和模块设计
- 代码重构总结 - 重构改进说明
- 错误处理增强 - 错误处理机制
- 问答 Bot 实施 - AI 功能实施文档
- RAG 技术文档 - RAG 技术实现
- 查询改写增强 - QA 引擎查询改写功能说明
- Ruff 脚本指南 - 代码质量工具
- CI/CD 工作流 - 持续集成配置
- 文档站维护与部署 - 本地预览与推送自动发布
🎯 快速查找
按主题查找
| 主题 | 用户文档 | 开发者文档 |
|---|---|---|
| 安装配置 | 快速开始 | 开发环境 |
| AI 功能 | 问答 Bot | 实施文档 |
| RAG 功能 | 快速启动 | 技术文档 |
| 投票功能 | 配置指南 | - |
| WebUI 面板 | WebUI 指南 | - |
| 转发管理 | WebUI 指南 | 架构设计 |
| 数据库管理 | WebUI 指南 | 架构设计 |
| 代码质量 | - | Ruff 指南 |
| 系统架构 | - | 架构设计 |
按难度查找
| 难度 | 文档 |
|---|---|
| ⭐ 入门 | 快速开始 · RAG 快速启动 |
| ⭐⭐ 进阶 | 问答 Bot 指南 · 投票功能 · WebUI 面板 |
| ⭐⭐⭐ 高级 | RAG 技术文档 · 架构设计 |
📖 文档结构说明
本文档采用 Diátaxis 文档框架 进行组织：
- 📘 教程 (Tutorials) - 手把手的学习型指南
- 📗 操作指南 (How-to Guides) - 解决具体问题的步骤说明
- 📙 参考资料 (Reference) - 技术细节和 API 文档
- 📕 解释说明 (Explanation) - 背景知识和概念讨论
文档分类标识
每个文档顶部都有分类标识：
分类: 用户文档 / 开发者文档
类型: 教程 / 操作指南 / 参考资料 / 解释说明
难度: ⭐ / ⭐⭐ / ⭐⭐⭐
更新时间: YYYY-MM-DD
🔗 相关资源
💡 获取帮助
如果您在使用过程中遇到问题：
- 📖 查阅相关文档
- 🔍 搜索 GitHub Issues
- 💬 参与 GitHub Discussions
- 📧 发送邮件至 sakura520222@outlook.com