文档包括RuyiSDK的总体介绍和各个组成部分的介绍和使用方法。
docs仓库采用vitepress技术将Markdown格式的文档自动生成为web页面,结合github-pages 设置,能够自动将文档更新进行发布。
- docs : Markdown文档;采用分级管理。
- .vitepress/config.mts : 目录索引定义。
欢迎大家一起参与RuyiSDK文档贡献。贡献方法:
- fork 本仓库;
- 在docs/docs/zh 目录下按需新建目录和markdown文档,或者修改已有的markdown文档;
- 修改docs/docs/.vitepress/config.mts 文档调整目录;
- 提交修改并创建pull request将文档贡献提交到docs仓库,等待仓库管理员审核合入;
- pr被合入后大约几十秒或几分钟后,访问 https://ruyisdk.github.io/docs 检查网页是否更新。