Skip to content

Commit 86bd5e6

Browse files
authored
docs/update contribution (#618)
* Docs: update contribution content * Docs: update contribution content
1 parent d231377 commit 86bd5e6

File tree

2 files changed

+66
-7
lines changed

2 files changed

+66
-7
lines changed

en/community/docs-contribution.md

+34-4
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,11 @@ Dify documentation is an [open-source project](https://github.com/langgenius/dif
66

77
We categorize documentation issues into two main types:
88

9-
* Content Corrections (Typos / Inaccuracies)
10-
* Content Additions (New documentation)
9+
* Content Corrections
10+
* Content Additions
11+
* Best Practices
1112

12-
### Content Errors
13+
### Content Corrections
1314

1415
If you encounter errors while reading a document or wish to suggest modifications, please use the **"Edit on GitHub"** button located in the table of contents on the right side of the document page. Utilize GitHub's built-in online editor to make your changes, then submit a pull request with a concise description of your edits. Please format your pull request title as `Fix: Update xxx`. We'll review your submission and merge the changes if everything looks good.
1516

@@ -31,14 +32,43 @@ git clone https://github.com/<your-github-account>/dify-docs.git
3132

3233
> Note: You can also use GitHub's online code editor to submit new Markdown files directly in the appropriate directory.
3334
34-
1. Locate the relevant document directory and add your file
35+
2. Locate the relevant document directory and add your file
3536

3637
For instance, if you're contributing documentation for third-party tools, please add new `.md` files to the `/guides/tools/tool-configuration/` directory.
3738

3839
3. Submit a pull request
3940

4041
When submitting a pull request, please use the format `Docs: Add xxx` for the title and provide a brief description in the comment field. We'll review your submission and merge the changes if everything is in order.
4142

43+
### Best Practices
44+
45+
We warmly encourage you to share the creative application scenarios you have built with Dify! To help community members better understand and replicate your hands-on experience, we recommend structuring your content as follows:
46+
47+
48+
```text
49+
1. Introduction
50+
- Application scenarios and problems addressed
51+
- Key features and highlights
52+
- Final results and demonstrations
53+
54+
2. Project Principles / Process Overview
55+
56+
3. Prerequisites (if any)
57+
- Required resource list
58+
- Tool and dependency requirements
59+
60+
4. Implementation in the Dify Platform (Suggested Steps)
61+
- Application creation and basic configurations
62+
- Process-building guide
63+
- Configuration details for key nodes
64+
65+
5. FAQ
66+
```
67+
68+
> For images and screenshots, please use online image hosting links in your documentation.
69+
70+
We look forward to your valuable contributions and to fostering knowledge within the Dify community together!
71+
4272
## Getting Help
4373

4474
If you ever get stuck or got a burning question while contributing, simply shoot your queries our way via the related GitHub issue, or hop onto our [Discord](https://discord.com/invite/8Tpq4AcN9c) for a quick chat.

zh_CN/community/docs-contribution.md

+32-3
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,11 @@ Dify 帮助文档是一个[开源项目](https://github.com/langgenius/dify-docs
44

55
## 如何提交贡献
66

7-
我们将文档问题分为以下几类
7+
我们将文档划分为以下类型
88

9-
* 内容勘误(错别字 / 内容不正确)
10-
* 内容缺失(需要补充新的内容)
9+
* 内容勘误
10+
* 内容缺失
11+
* 最佳实践
1112

1213
### 内容勘误
1314

@@ -39,6 +40,34 @@ git clone https://github.com/<your-github-account>/dify-docs.git
3940

4041
提交 pull request 时,请使用 `Docs: add xxx` 的格式,并在描述栏内简单说明文档的大致内容,我们在收到请求后进行 review,无误后将合并你的修改。
4142

43+
### 最佳实践
44+
45+
我们非常欢迎你分享使用 Dify 搭建的创新应用案例!为了帮助社区成员更好地理解和复现你的实践经验,建议按照以下框架来组织内容:
46+
47+
```text
48+
1. 项目简介
49+
- 应用场景和解决的问题
50+
- 核心功能和特点介绍
51+
- 最终效果展示
52+
53+
2. 项目原理/流程介绍
54+
55+
3. 前置准备(如有)
56+
- 所需资源清单
57+
- 工具依赖要求
58+
59+
4. Dify 平台实践步骤(参考)
60+
- 应用创建和基础配置
61+
- 应用流程搭建详解
62+
- 关键节点配置说明
63+
64+
5. 常见问题
65+
```
66+
67+
> 为了便于用户理解,建议为文章添加必要说明截图。请以在线图床链接的形式提交图片内容。
68+
69+
我们期待你的精彩分享,一起助力 Dify 社区的知识积累!
70+
4271
## 获取帮助
4372

4473
如果你在贡献过程中遇到困难或者有任何问题,可以通过相关的 GitHub 问题提出你的疑问,或者加入我们的 [Discord](https://discord.com/invite/8Tpq4AcN9c) 进行快速交流。

0 commit comments

Comments
 (0)