贡献技术文档

感谢您帮助改进 WooCommerce 的开发者文档。 我们的文档由 Docusaurus 提供支持，位于 monorepo 中的 
woocommerce/docs/ 文件夹中。
本指南将引导您了解贡献的结构、工具和流程。
快速开始
本指南假设您熟悉基本的 Git 和 GitHub 功能，并且您已登录到 GitHub 帐户，并且已在本地配置了 Git。 如果您是 GitHub 的新手，我们建议您在开始之前阅读他们的 快速入门 和 使用分支 指南。
初始设置
在 GitHub 上 fork WooCommerce monorepo。 如果提示，您可以安全地选中 
copy the trunk branch only 选项。
克隆您刚刚创建的分支。 这将允许您在本地进行编辑。
进行更改
在进行任何更改之前，请确保您的 
trunk 分支与 monorepo 的 
trunk 同步。
对于您想要进行的每项修改，请在您的 fork 中，从 
trunk 创建一个以 
docs/ 开头的新的分支。 例如，如果您要添加一个关于改进扩展性能的文档，您可以将分支命名为 
docs/improve-extension-performance。
在 
docs/ 下的适当文件夹中创建或编辑 Markdown 文件。
如果需要，请更新文件夹中的 
_category_.json 文件（用于侧边栏标签/位置）。
运行构建以验证更改，确认站点地图和 llms-txt 文件已更新，并检测 Markdown 语法错误和断开的链接（链接检查仅在构建时进行）：
npm run build
打开拉取请求
提交并推送到您的 fork。
打开一个拉取请求 到 woocommerce/woocommerce，目标分支为 
trunk。
使用描述性的标题，并填写 PR 模板。 包含：
新文件或分类的理由
关于任何侧边栏或结构更改的说明
WooCommerce 开发者倡导团队将审查并合并您的更改。
文档文件夹结构
工具和配置
支持工具和配置 位于：
woocommerce/docs/_docu-tools/
顶层侧边栏和导航栏 的配置位于：
sidebars.ts
docusaurus.config.ts
文档文件
文档位置: 所有文档都位于 
woocommerce/docs/ 目录下。
每个文件夹代表一个侧边栏或顶层导航的分类，例如：
getting-started、
code-snippets 等。
每个分类的侧边栏配置 使用每个分类文件夹内的 
_category_.json 文件进行管理：
{
    "position": 7,
    "label": "Code snippets"
}
添加图像
所有文档图像都存储在：
docs/_docu-tools/static/img/doc_images/
要在 Markdown 文件中包含图像，请按以下方式引用它：
![Alt Text](https://raw.githubusercontent.com/woocommerce/woocommerce/trunk//img/doc_images/your-image-name.png)
创建新的分类
在创建新的分类之前，您应该考虑是否真的有必要这样做。 尽可能地，应该将内容创建在现有的分类中。 如果确实需要创建新的分类，请按照以下步骤操作：
在 
/docs 文件夹中，创建一个具有描述性名称的子文件夹。 例如，如果您想创建一个 
Checkout design guidelines 部分，则创建一个名为 
/docs/checkout-design-guidelines 的文件夹。
在每个分类文件夹中创建一个 
_category_.json 文件，并指定其在侧边栏中的位置以及标签：
{
    "position": 10,
    "label": "Checkout design guidelines"
}
在创建新的分类时，请在您的拉取请求的描述中包含创建该分类的理由。
撰写指南和参考
使用短的、适合 URL 的文件名（kebab-case，不包含空格）。
避免从富文本编辑器（如 Google Docs）粘贴内容，因为这可能会引入无效的字符。
请参考我们的 文档风格指南，以获取详细的撰写指南。
请参考 Docusaurus 文档，以获取更多指导。