Cherry Studio 开发文档
支持多服务商集成的AI对话客户端
概述
对 Cherry Studio的代码和开发环境进行简单描述
Cherry Studio是一个基于electron开发的AI对话客户端,在拥有基本的AI对话功能的前提下,Cherry Studio融合了多种可以增强AI对话的交互功能,包括但不限于本地知识库,MCP,联网搜索,多种软件/格式导出 等等。截止到3月28日,Cherry Studio的总代码行数已经超过了5w行。所以,对于想要对其进行二次开发或者进行软件维护的开发者来说,开发文档的搭建迫在眉睫。
基于该开发文档,GitHub Issues & Pull Request,以及与其他开发者的沟通,每一位开发者都能够以更快的速度上手,为Cherry Studio贡献自己的一份力量。
开发前须知
对于新手来说,怎么开始第一次PR?怎么帮助开发者社区进行文档修改?这些工作和“写代码”没有直接关系,但是却是作为开源程序员不得不学习的流程。
关于PR (Pull Requests | 拉取请求)
在 GitHub 中,拉取请求(Pull Request,简称 PR)是一种协作机制,允许您通知他人您对仓库所做的更改,并请求将这些更改合并到主项目中。这对于协作开发、代码审查以及确保项目质量至关重要。有关拉取请求的更多详细介绍,请阅读拉取请求文档-GitHub开发文档
当然,如果你只是想快速进行一次拉取请求的操作,且曾经还没有过给项目提交修改的经验,那么在提交代码前这份更简单的文档相信一定能帮到你,请务必仔细阅读(不仔细也没事就是小心被人骂罢了)。
文档结构
该part用于对于当前代码的分析,包括每个代码的函数使用、结构分析、数据流向等
客户端构成
数据与存储
渲染进程
最后更新于
这有帮助吗?