文档提交

本系列指南，简单来说就是编写文档的文档。

在撰写所有文档前，强烈建议先阅读完本系列教程。

分支介绍

本文档主要有三个分支，main，dev，gh-pages。

其中main分支和gh-pages分支是不建议直接改动的。因为所有提交到main分支的改动，都会触发Github Actions的自动构建，重新打包并部署本文档，从而影响线上文档。因此，要提交改动，请先在dev分支上进行改动，确认文档无误和项目运行正常后，再将dev分支合并到main分支上。

而gh-pages分支则是用于存放Github Actions自动构建部署的文件，并用于Github Pages生成静态页面。因此，任何对改分支的改动，都会直接影响到线上文档。不建议任何对此分支进行改动

编辑流程

在提交文档的改动前，建议先阅读本文档的使用Git工作流。

而本文档的改动流程基本如下：

可以看到，所有的改动都是先在dev分支上进行的。当确认dev分支中的文档改动无误和项目运行正常后，再将dev分支合并到main分支中并提交。