Skip to content

文档标准

Luna-Flow/quaternion 的文档必须描述当前分支里的真实实现,并且持续与导出接口、仓库结构和版本叙事保持一致。

Rules

  • 每个支持语言都提供 README.mddoc_standard.md 和按模块或子系统组织的文档。
  • 只记录当前分支已经存在的 API、工作流和设计约束,不写计划中接口。
  • 目录结构必须与真实包边界或子系统边界对齐。
  • 每个模块或子系统目录都包含 api.mdtutorial.mddesign.md
  • 当可观察语义存在差异时,要在相关文档之间建立交叉引用并明确说明。