Skip to content

Diataxis 概览(中文)

本项目文档采用 Diataxis 四分法:

  • 教程(Tutorials):面向初学者的逐步学习路径。
  • 操作指南(How-To):面向任务执行的步骤化说明。
  • 参考(Reference):权威接口、契约与策略说明。
  • 解释(Explanation):架构动机、取舍与迁移背景。

治理机制

常用命令

npm run docs:diataxis:check
mkdocs serve --config-file mkdocs.yml
mkdocs build --config-file mkdocs.yml
# 发布由 GitHub Actions 工作流 Docs GitHub Pages Publish 执行

权威来源文档

运行时配置入口

进度跟踪入口