Skip to content

Commit 1cdc6b4

Browse files
authored
Revert "Docs: update contribution content (#616)"
This reverts commit 37e5ea2.
1 parent 37e5ea2 commit 1cdc6b4

File tree

2 files changed

+5
-74
lines changed

2 files changed

+5
-74
lines changed

en/community/docs-contribution.md

+2-38
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,8 @@ 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
10-
* Content Additions
11-
* Best Practices
9+
* Content Corrections (Typos / Inaccuracies)
10+
* Content Additions (New documentation)
1211

1312
### Content Errors
1413

@@ -40,41 +39,6 @@ For instance, if you're contributing documentation for third-party tools, please
4039

4140
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.
4241

43-
### Best Practices
44-
45-
Best Practices
46-
47-
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:
48-
49-
50-
```text
51-
1. Introduction
52-
- Application scenarios and problems addressed
53-
- Key features and highlights
54-
- Final results and demonstrations
55-
56-
2. Project Principles / Process Overview
57-
58-
3. Prerequisites (if any)
59-
- Required resource list
60-
- Tool and dependency requirements
61-
62-
4. Implementation in the Dify Platform (Suggested Steps)
63-
- Application creation and basic configurations
64-
- Process-building guide
65-
- Configuration details for key nodes
66-
67-
5. FAQ
68-
- Typical development challenges
69-
- Troubleshooting and solutions
70-
- Performance optimization tips
71-
- Additional notes and best practices
72-
```
73-
74-
> For images and screenshots, please use online image hosting links in your documentation.
75-
76-
We look forward to your valuable contributions and to fostering knowledge within the Dify community together!
77-
7842
## Getting Help
7943

8044
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

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

55
## 如何提交贡献
66

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

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

1312
### 内容勘误
1413

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

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

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-
```
70-
71-
> 为了便于用户理解,建议为文章添加必要说明截图。请以在线图床链接的形式提交图片内容。
72-
73-
我们期待你的精彩分享,一起助力 Dify 社区的知识积累!
74-
7542
## 获取帮助
7643

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

0 commit comments

Comments
 (0)