关于本文档
贡献指南
关于本文档
贡献指南
欢迎参与 Dify 文档的协同构建！本指南旨在阐述 Dify 开发者文档的贡献流程与规范，鼓励并协助社区成员共同提升文档质量。
更新现有文档
在您希望修改的文档页面末尾，点击 编辑此页面 按钮。这将直接链接到 GitHub 上对应的源文件。
在您希望修改的文档页面末尾，点击 编辑此页面 按钮。这将直接链接到 GitHub 上对应的源文件。
Dify 文档的 URL 与其在 GitHub 仓库中的相对路径存在明确的对应关系，可供熟悉结构的贡献者参考：
| 网址 (示例) | GitHub 仓库相对路径 (示例) |
|---|---|
https://docs.dify.ai/plugin-dev-zh/0111-getting-started-dify-plugin | plugin-dev-zh/0111-getting-started-dify-plugin.mdx |
编辑时，请专注于正文内容的准确性和清晰度。文件头部的 Frontmatter 元数据及末尾的特定脚本或包含内容，通常由核心贡献者或通过自动化流程进行管理和维护。
如发现文档问题，您也可以通过页面上的 提交问题 按钮向我们报告。准确的问题反馈对社区和项目而言都是重要的贡献。
创建新文档
1
创建文件
在相应的语言目录下 (例如 plugin-dev-zh) 创建一个新的 .mdx 文件。
创建新文档
点击此卡片，直接在 GitHub 上创建文档。
初始文件名可自行定义 (例如 qwertyuiop12345678.mdx)，文件名必须足够长。
2
编写内容
3
添加 Frontmatter (元数据)
每篇文档都需要定义 Frontmatter 元数据：
- 正确配置的 Frontmatter 是确保文档能够被系统准确索引、排序并在文档网站上正确显示和导航的关键。
- 您的首要任务是贡献高质量、准确的文档内容。
- 如果您熟悉 Dify 的 文档 Frontmatter 元数据指南，我们非常欢迎您在提交时包含 Frontmatter。
- 如果您不确定如何填写 Frontmatter，或者希望专注于内容创作，完全没有问题。 您可以提交不包含 Frontmatter 或仅包含部分元数据的 Pull Request。社区和项目核心贡献者会协助您进行后续的添加、审核与优化。
您的内容贡献至关重要。 即使您未提供完整的 Frontmatter，您的 Pull Request 依然受欢迎。确保文档最终拥有规范的元数据并成功集成，是社区与核心团队协作完成的工作。
提交您的贡献
完成编辑或创建新文档后，请通过 GitHub 向主仓库提交 Pull Request。社区成员和项目维护者将对您的贡献进行审阅。
常见问题解答
感谢您为 Dify 社区和文档建设贡献力量！