paion-data/minerva

编写文档

Closed this issue · 0 comments

QubitPi commented

目标

初始化项目文档，为将来的开发同学和用户提供很好的使用说明

实现步骤

  1. 在 Minerva 顶级目录下用 docusaurus 生成 docs 文档模板

  2. 对模板做如下修改：

    • 网站域名：minerva.paion-data.dev

    • 删掉 blog 以及相关代码和配置

    • 全局所有 “Tutorials” 重命名成 “Documentation”

    • Documentation（docs/docs） 预置的内容仅留下 intro.md，剩下两个子文件夹直接删除

    • intro.md 里面编写如何使用 docker-compose 的文档

      • 可以咨询 @Doom9527 如何使用自动翻译插件
      • 也可以直接写英文

  3. 在 CI/CD 中加入文档测试和发布逻辑，可以参考 astraios 和 athena