openUBMC社区文档中心。
需要安装nodejs便可以在本地拉起文档服务
前往nodejs官网下载最新nodejs安装包并进行安装。
推荐使用华为云npm镜像服务，加速第三方软件下载。
https://mirrors.huaweicloud.com/mirrorDetail/5ea0f1e03fdb11a72fd319b2
nodejs安装完毕后，安装npm相关依赖
npm installnpm run docs:dev网页访问http://localhost:5174/docs/zh/development/quick_start/explore_openubmc.html即可。
文档目录在docs/public/menu/development/menu.json进行定义，具体语法如下：
{
"id": "quick_start", // 访问中url一环。如果有children，则此级无法访问
"label": { // 目录在左侧的显示文字
"zh": "快速入门",
"en": "Quick Start"
},
"children": [{ // 子目录，支持嵌套
"id": "explore_openubmc", // 子节点markdown名称，此例子下在quick_start/explore_openubmc.md
"label": {
"zh": "探索openUBMC",
"en": "Explore OpenUBMC"
}
}]
}文档目录在docs/public/zh/development/进行定义，路径需与menu.json中节点定义一致。
文档头部需要添加信息，具体如下：
---
date: 2025/04/01 // 最后修改日期
title: BMC Studio安装指南 // 文档标题
---
--- // 分割线
注意：
由于框架限制，正文中无法使用{{}}花括号，会导致前段编译失败。
文档编写统一使用markdown格式。
文档中的语句需要通顺，连贯，通俗易懂。语句无语法错误和语法问题，无错别字。编写避免造成歧义。
可使用大模型进行文档优化语法和描述。
社区文档的目标是为社区开发者提供openUBMC的知识体系，文档结构性要求较高，因此需要在整体架构下进行内容和知识扩充。
快速入门旨在提供最基础的入门教程，即能体现openUBMC的一些独特优势，也能让开发者快速上手体验。
快速入门同时包含环境搭建章节。
具体要求如下：
- 案例需要简单: 开发者仅需遵循每一步流程即可达到对应步骤的效果。
- 知识不扩散: 关注流程而非平铺知识点，开发者无需深入学习了解知识也能操作每一个步骤。
- 知识点可查询：所有openUBMC相关名词都有解释，并可跳转至具体的介绍章节。
当前规划章节：
- 一键出包能力：体验快速出包的能力，开发者可快速体验openUBMC的能力。
- 新建组件能力：体验新组件开发的能力，开发者可快速体验组件创建并调试的能力。
- 扩展接口能力：体验接口扩展的配置能力，开发者可快速体验接口定制的能力。
- 部件定制能力：体验硬件适配的配置能力，开发者可快速理解部件管理相关能力。
开发指南旨在提供基于场景式的开发指导，目标是帮助开发者给予自己的目标，开始上手进行开发和定制。
具体要求如下：
- 案例为中心：开发者无需知道自己到底要什么知识点，而是基于自己的实际场景进行学习。
- 内容要全：主要介绍具体有什么功能，而非解释其原理。开发者仅需学习使用方法即可完成对应的开发工作。
当前规划章节：
- 组件开发：旨在帮助开发者回答在开发一款组件时遇到的问题，并给出具体的介绍和步骤详情。
- 产品开发：旨在帮助开发者回答在产品定制时遇到的问题，并给出具体的介绍和步骤详情。
- 特性开发：旨在帮助开发者回答在具体特性开发时遇到的问题，并给出具体的介绍和步骤详情。
参考指南旨在提供方案和原理，目标是帮助开发者理解背后的设计概念以及原理，便于更深度的开发和设计自己的特性和需求。
参考指南内容仍在补齐，甚至考虑变成方案设计的归档地址，如果有任何建议，请联系docs sig
具体要求如下：
- 原理解释：从架构、特性方案的角度介绍一个特性。
当前规划章节：
- 关键特性：开发者常见的关键特性，了解其设计方案和实现机制。
测试指南旨在提供测试相关方案设计的指导，帮助开发者完成测试方案的输出。
当前规划章节：
- 特性测试方案：针对特性级别的测试方案设计，如何覆盖场景并完成特性测试验收。
- 测试用例设计：具体的测试用例如何设计，高效地完成测试方案中需要验证的点。
- 总体测试策略：针对整体系统性的测试方案设计，保障端到端流程覆盖和整体测试策略。
工具指南旨在提供工具相关的使用指南，帮助开发者了解并学习工具的使用方式。
当前规划章节：
- bingo
- BMC Studio
常见问题是FAQ的集合，旨在帮助开发者回答一些常见问题。
FAQ仍在规划建设中。如果有任何建议，请联系docs sig
API文档旨在提供全面的接口使用指导，帮助开发者查询具体的接口使用细节。
API文档正在考虑重新设计中，如果有任何建议，请联系docs sig
当前规划章节：
- openUBMC SDK：基于社区发行版的
mdb_interface自动生成的文档。 - 组件文档：基于社区各组件readme（考虑日落中）
术语表旨在提供openUBMC名词解释表，帮助开发者理解和学习具体的名词定义。