文档仓目录结构说明
更新时间：2025/5/16
在Gitcode上查看源码手册
文档中心有九本手册：快速入门、开发指南、参考指南、工具指南、测试指南、常见问题、API文档、术语表和文档开发指南，分别对应 docs 仓内 docs/zh/development 目录下的 quick_start、develop_guide、design_reference、tool_guide、test_guide、faq 、 api 和 document_develop_guide 子目录，术语表对应 development 子目录。
文档仓手册相关目录结构示例如下：
text
├─Archive
├─docs
│ ├─public <!-- 公共文档，包含：目录结构文件（_menu.json） -->
│ ├─en
│ └─zh
│ └─development
│ ├─quick_start <!-- 手册：快速入门 -->
│ ├─develop_guide <!-- 手册：开发指南 -->
│ ├─design_reference <!-- 手册：参考指南 -->
│ ├─tool_guide <!-- 手册：工具指南 -->
│ ├─test_guide <!-- 手册：测试指南 -->
│ ├─faq <!-- 手册：常见问题 -->
│ ├─api <!-- 手册：API参考 -->
│ ├─glossary.md <!-- 手册：术语表 -->
│ └─document_develop_guide <!-- 手册：文档开发指南 -->目录
各手册下均有具体的目录划分。以开发指南手册为例，其进一步细分为简介、组件开发、产品开发、特性开发等一级目录。
文档仓开发指南目录结构示例如下：
text
├─docs
│ ├─public <!-- 公共文档，包含：目录结构文件（_menu.json） -->
│ ├─en
│ └─zh
│ └─development
│ └─develop_guide <!-- 手册：开发指南 -->
│ ├─app_development <!-- 一级目录：组件开发 -->
│ ├─feature_development <!-- 一级目录：特性开发 -->
│ └─product_development <!-- 一级目录：产品开发 -->部分一级目录会进一步细分出二级目录，以开发指南手册中的特性开发目录为例，其下进一步划分出二级目录，分别为WebUI用户指南、板卡适配、接口定制、传感器定制与开发等。
文档仓服务器下特性开发的目录结构示例如下：
text
├─docs
│ ├─en
│ └─zh
│ └─development
│ ├─develop_guide <!-- 手册：开发指南 -->
│ ├─quick_start <!-- 手册：快速入门 -->
│ ├─api <!-- 手册：API参考 -->
│ ├─design_reference <!-- 手册：参考指南 -->
│ ├─tool_guide <!-- 手册：工具指南 -->
│ ├─test_guide <!-- 手册：测试指南 -->
│ ├─faq <!-- 手册：常见问题 -->
│ └─develop_guide <!-- 手册：开发指南 -->
│ ├─app_development <!-- 一级目录：组件开发 -->
│ ├─product_development <!-- 一级目录：产品开发 -->
│ └─feature_development <!-- 一级目录：特性开发 -->
│ ├─webui_user guide <!-- 二级目录：WebUI用户指南 -->
│ ├─kaeboard_integration <!-- 二级目录：板卡适配 -->
│ ├─interface_customization <!-- 二级目录：接口定制 -->
│ └─sensor <!-- 二级目录：传感器定制与开发 -->文档
每本手册分别对应文档仓的一个文件夹。每本手册包含一个或多个文档内容文件（.md文件）。
文档仓服务器下快速入门手册的文档目录结构示例如下：
text
├─Archive
├─docs
│ ├─public <!-- 公共文档，包含：目录结构文件（_menu.json） -->
│ ├─en
│ └─zh
│ └─development
│ ├─quick_start <!-- 手册：快速入门 -->
│ ├─explore_openubmc.md <!-- 文档：探索openUBMC -->
│ ├─env_introduction.md <!-- 文档：环境准备 -->
│ ├─build_your_own_bmc.md <!-- 文档：构建你的BMC -->
│ ├─create_an_app.md <!-- 文档：新增一个组件 -->
│ ├─extend_bmc_api.md <!-- 文档：扩展对外接口 -->
│ └─integrate_a_device.md <!-- 文档：适配一款硬件 -->
│ ├─develop_guide <!-- 手册：开发指南 -->
│ ├─design_reference <!-- 手册：参考指南 -->
│ ├─tool_guide <!-- 手册：工具指南 -->
│ ├─test_guide <!-- 手册：测试指南 -->
│ ├─faq <!-- 手册：常见问题 -->
│ └─api <!-- 手册：API参考 -->