# 贡献文档

## 前置条件

为该项目做出贡献之前，请先阅读[本地部署文档项目](../deploy/document-deploy.md)

## 本地文档贡献指南

### 操作流程

接下来，你可以在`docs/`文件夹下正常的文档编写。

### 国际化

你可以通过运行`gettext_generator.py`脚本来生成项目文档的翻译字符串，对于母语非中文的用户，我们推荐的是首先使用您熟悉的语言编写文档，然后使用 AI 翻译工具翻译为中文并粘贴到文档，然后将您的翻译内容放在您的语言所对应的翻译中.

请注意，生成翻译字符串的部分并不是必须的，我们有 github 的定时任务生成翻译字符串，同时，为文档同时编写其所有翻译也是不现实的，您只需要完成其中一种语言的编写即可，剩下的将会由文档项目的开发者补全翻译。

除此之外，你也可以通过一个简单的小脚本`find_untranslate.py`来找出所有的未翻译字符串。

## 操作细节

如果您要创建一个新的文档部分，您需要将您的文档(md 或 rst 文件都是受到支持的)分门别类的放在`source`文件夹中，并对应修改`index.rst`中的内容，使得你的文档能够被识别到。接下类，构建并检验您的文档是否发挥了作用。

感谢您的贡献，期待您在文档的贡献中获得乐趣，如果您有任何问题，请随时打开一个 issue!