Apinto 文档协作指南

本文是关于 Apinto文档手册的纠错协作指南，如果您对当前教程中的内容、分类、排版及样式有任何优化的建议，均可以参照该指南在 Apinto document 发起纠错支持，我们十分期待您能够成为 Apinto 开源贡献者的一员~

本教程由 VuePress 搭建，关于 VuePress 的 markdown 语法编写技巧及细节，可参考官方的 Frontmatter，同时可以借助 Register-Components，实现自定义页面/组件，具体示例也可参考已有的教程内容，如关于Apinto

我们规定教程相关文档统一放置于 /docs 目录下，如果您觉得当前教程存在不清晰的地方，可直接选择修改 /docs 目录下相应的 markdown 文件

教程内容修改完善后，您可以参考编译构建以预览修改效果，并基于 PR协作的方式提请项目合并，我们将及时响应您的请求，期待您的纠错~

新增教程主要涉及文档的新增和目录索引的配置

我们规定教程相关文档统一放置于 /docs 目录下，您可以在 /docs 目录下新增相应的 markdown 文档，不同类别的教程分别放置在 /docs 中不同的子目录下，例如：鉴权(auth)相关的文档我们规定置于 /docs/auth 的目录中

配置目录索引的目的在于让教程页面展示快捷的侧边导航，方便用户准确定位相关教程，导航预览效果如图所示

新增教程内容后，可选择在 /.vuepress/config.js 修改 sidebar 配置，具体的配置字段可参考 sidebar 或已有配置，如上述鉴权教程的目录配置如图所示

教程内容新增完善后，您可以参考编译构建以预览修改效果，并基于 PR协作的方式提请项目合并，我们将及时响应您的请求，期待您的积极参与~

修改/新增教程内容后，您可选择在本地进行编译以预览修改效果，构建命令为：

yarn build

构建成功后，程序会在 /.vuepress 下创建名为 dist/ 的文件夹，其中内容即是构建后的静态资源，如果需要在本地预览，也可以运行 yarn dev 命令，在本地临时启动一个静态资源服务器，即可预览构建后的最终效果。

同时也可以选择将 dist/ 中的内容放置到正式服务器上浏览。

当您新增/修改教程内容后，可以在 Fork Apinto document 项目后提请 Pull Request，选择合并至目标项目的 main 分支

我们将及时响应您的 PR 请求，期待您成为 Apinto 开源贡献者的一员~

如果您在使用 Apinto 的过程中碰到问题，可以在以下途径在 Apinto 开源社区中寻求帮助，我们会及时响应，同时我们也鼓励资深用户在社区中为新人提供帮助。