You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: en/community/docs-contribution.md
+38-2
Original file line number
Diff line number
Diff line change
@@ -6,8 +6,9 @@ Dify documentation is an [open-source project](https://github.com/langgenius/dif
6
6
7
7
We categorize documentation issues into two main types:
8
8
9
-
* Content Corrections (Typos / Inaccuracies)
10
-
* Content Additions (New documentation)
9
+
* Content Corrections
10
+
* Content Additions
11
+
* Best Practices
11
12
12
13
### Content Errors
13
14
@@ -39,6 +40,41 @@ For instance, if you're contributing documentation for third-party tools, please
39
40
40
41
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.
41
42
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
+
42
78
## Getting Help
43
79
44
80
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.
0 commit comments