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
+34-4
Original file line number
Diff line number
Diff line change
@@ -6,10 +6,11 @@ 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
-
### Content Errors
13
+
### Content Corrections
13
14
14
15
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.
> Note: You can also use GitHub's online code editor to submit new Markdown files directly in the appropriate directory.
33
34
34
-
1. Locate the relevant document directory and add your file
35
+
2. Locate the relevant document directory and add your file
35
36
36
37
For instance, if you're contributing documentation for third-party tools, please add new `.md` files to the `/guides/tools/tool-configuration/` directory.
37
38
38
39
3. Submit a pull request
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
+
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
+
42
72
## Getting Help
43
73
44
74
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