mirror of
https://github.com/langgenius/dify-docs.git
synced 2026-03-27 13:28:32 +07:00
134 lines
5.2 KiB
Plaintext
134 lines
5.2 KiB
Plaintext
---
|
||
dimensions:
|
||
type:
|
||
primary: reference
|
||
detail: core
|
||
level: beginner
|
||
standard_title: 'Doc Contribution Guide'
|
||
language: zh
|
||
title: '贡献指南'
|
||
summary: '了解如何为 Dify 开发者文档贡献内容，包括更新现有文档和创建新文档的步骤与规范，共同建设高质量的文档资源。'
|
||
---
|
||
|
||
欢迎参与 Dify 文档的协同构建！本指南旨在阐述 Dify 开发者文档的贡献流程与规范，鼓励并协助社区成员共同提升文档质量。
|
||
|
||
## 更新现有文档
|
||
|
||
<Tabs>
|
||
<Tab title="推荐方式">
|
||
在您希望修改的文档页面末尾，点击 <Icon icon="pen-to-square" /> **编辑此页面** 按钮。这将直接链接到 GitHub 上对应的源文件。
|
||
|
||
</Tab>
|
||
<Tab title="通过 URL 定位">
|
||
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` |
|
||
</Tab>
|
||
</Tabs>
|
||
|
||
---
|
||
|
||
<Note>
|
||
编辑时，请专注于正文内容的准确性和清晰度。文件头部的 Frontmatter 元数据及末尾的特定脚本或包含内容，通常由核心贡献者或通过自动化流程进行管理和维护。
|
||
</Note>
|
||
|
||
<Check>
|
||
如发现文档问题，您也可以通过页面上的 **提交问题** 按钮向我们报告。准确的问题反馈对社区和项目而言都是重要的贡献。
|
||
</Check>
|
||
|
||
## 创建新文档
|
||
|
||
<Steps>
|
||
<Step title="创建文件">
|
||
在相应的语言目录下 (例如 `plugin-dev-zh`) 创建一个新的 `.mdx` 文件。
|
||
|
||
<Card
|
||
title="创建新文档"
|
||
icon="pen-to-square"
|
||
href="https://github.com/langgenius/dify-docs/new/test-action/plugin-dev-zh"
|
||
horizontal
|
||
>
|
||
点击此卡片，直接在 GitHub 上创建文档。
|
||
</Card>
|
||
|
||
初始文件名可自行定义 (例如 `qwertyuiop12345678.mdx`)，文件名必须足够长。
|
||
|
||
</Step>
|
||
|
||
<Step title="编写内容">
|
||
<Accordion title="Markdown 语法规范">
|
||
请遵循标准的 **Markdown** 语法。在 MDX 文件中，注释请使用 JSX 风格：`{/* 这是一个 MDX 注释 */}`，而非 HTML 风格的 `<!-- comment -->`。
|
||
</Accordion>
|
||
|
||
<Accordion title="Mintlify 组件">
|
||
可适当运用 Mintlify 提供的组件优化内容结构与呈现：
|
||
|
||
```jsx
|
||
<Note>
|
||
这是一个重要提示。
|
||
</Note>
|
||
|
||
<Warning>
|
||
这是一个警告信息。
|
||
</Warning>
|
||
|
||
<Card title="相关资源" icon="book">
|
||
更多内容请参考相关资源...
|
||
</Card>
|
||
```
|
||
|
||
更多组件请参考 [Mintlify 组件文档](https://mintlify.com/docs)。
|
||
</Accordion>
|
||
</Step>
|
||
|
||
<Step title="添加 Frontmatter (元数据)">
|
||
每篇文档都需要定义 Frontmatter 元数据：
|
||
|
||
* 正确配置的 Frontmatter 是确保文档能够被系统准确索引、排序并在文档网站上正确显示和导航的关键。
|
||
* **您的首要任务是贡献高质量、准确的文档内容。**
|
||
* 如果您熟悉 Dify 的 [文档 Frontmatter 元数据指南](/plugin-dev-zh/0412-doc-writing-dimensions-guide)，我们非常欢迎您在提交时包含 Frontmatter。
|
||
* **如果您不确定如何填写 Frontmatter，或者希望专注于内容创作，完全没有问题。** 您可以提交不包含 Frontmatter 或仅包含部分元数据的 Pull Request。社区和项目核心贡献者会协助您进行后续的添加、审核与优化。
|
||
</Step>
|
||
</Steps>
|
||
|
||
<Check>
|
||
**您的内容贡献至关重要。** 即使您未提供完整的 Frontmatter，您的 Pull Request 依然受欢迎。确保文档最终拥有规范的元数据并成功集成，是社区与核心团队协作完成的工作。
|
||
</Check>
|
||
|
||
## 提交您的贡献
|
||
|
||
完成编辑或创建新文档后，请通过 GitHub 向主仓库提交 Pull Request。社区成员和项目维护者将对您的贡献进行审阅。
|
||
|
||
## 常见问题解答
|
||
|
||
<AccordionGroup>
|
||
<Accordion title="我没有编程背景，可以贡献文档吗？">
|
||
当然可以！文档贡献不需要编程技能。如果您对 Dify 有所了解，您可以帮助改进现有文档的清晰度、准确性，或添加更多用户友好的说明和示例。
|
||
</Accordion>
|
||
|
||
<Accordion title="如何确保我的贡献被接受？">
|
||
确保您的内容清晰、准确，并遵循我们的格式指南。在提交前检查拼写和语法。如果不确定，可以在提交前在社区中讨论您的想法。
|
||
</Accordion>
|
||
|
||
<Accordion title="我可以用英语以外的语言贡献吗？">
|
||
可以！我们欢迎多语言文档贡献。请确保您的文件放在对应语言的目录中，并在 Frontmatter 中正确标注语言代码。
|
||
</Accordion>
|
||
</AccordionGroup>
|
||
|
||
---
|
||
|
||
感谢您为 Dify 社区和文档建设贡献力量！
|
||
|
||
{/*
|
||
Contributing Section
|
||
DO NOT edit this section!
|
||
It will be automatically generated by the script.
|
||
*/}
|
||
|
||
---
|
||
|
||
[编辑此页面](https://github.com/langgenius/dify-docs/edit/main/plugin-dev-zh/0411-doc-contribution-guide.mdx) | [提交问题](https://github.com/langgenius/dify-docs/issues/new?template=docs.yml)
|
||
|