lss233 / chatgpt-mirai-qq-bot

🚀 一键部署!真正的 AI 聊天机器人!支持ChatGPT、文心一言、讯飞星火、Bing、Bard、ChatGLM、POE,多账号,人设调教,虚拟女仆、图片渲染、语音发送 | 支持 QQ、Telegram、Discord、微信 等平台
GNU Affero General Public License v3.0
13.37k stars 1.57k forks source link

[Feature] 整理一份完整且简单的使用文档 #440

Closed lss233 closed 1 year ago

lss233 commented 1 year ago

随着项目功能的修改与增加,先前的文档已经过时了。 我们需要一份新的使用文档。
这包括:

  1. [ ] 部署的基本流程 (Windows 快速部署/ Linux 一键脚本 / Docker 等)
  2. [x] 如何修改配置文件
    • [x] 平台配置
      • [x] Mirai
      • [x] OneBot
      • [x] Telegram
      • [x] Discord
    • [x] AI 配置
      • [x] OpenAI ChatGPT
      • [x] OpenAI API
      • [x] 文心一言
      • [x] Google Bard
      • [x] Quora POE
      • [x] ChatGLM
    • [x] 功能设置
      • [x] 文字转语音
      • [x] 文字转图片
    • [x] 指令配置
    • [x] 文案修改
  3. [x] 如何编写预设
  4. [ ] 基本故障排查
    • [ ] 机器人不回复怎么办
    • [ ] QQ 如何登录
    • [ ] 其他

这份新的使用文档基本上就是将现有的文档重新整理一遍,使用更简单的语言重新描述一遍。

可以参考 sagiri-bot 的使用文档的展示形式:https://sagiri-kawaii.github.io/sagiri-bot/

gebederry commented 1 year ago

建议在 readme 展示的配置类代码块全部折叠

lss233 commented 1 year ago

建议在 readme 展示的配置类代码块全部折叠

我觉得这样只会让【视力不好的人】更难找到需要的东西。

lss233 commented 1 year ago

施工现场:https://darks-organization.gitbook.io/chatgpt-qq/