Skip to content

文档标准

仓库文档必须描述当前分支上的真实实现。

规则

  • 每个支持的语言目录都需要提供 README.mddoc_standard.md 和结构化的包或子系统文档。
  • 只记录当前分支真实存在的 API、工作流和设计决策。
  • 目录结构必须与真实包边界或子系统边界保持一致。
  • 每个包或子系统目录都必须包含 api.mdtutorial.mddesign.md