mirror of
https://github.com/langgenius/dify-docs.git
synced 2026-03-27 13:28:32 +07:00
103 lines
4.4 KiB
Plaintext
103 lines
4.4 KiB
Plaintext
---
|
|
title: Contributing to Dify Documentation
|
|
---
|
|
|
|
|
|
Dify documentation is an [open-source project](https://github.com/langgenius/dify-docs), and we welcome contributions. Whether you've spotted an issue while reading the docs or you're keen to contribute your own content, we encourage you to submit an issue or initiate a pull request on GitHub. We'll address your PR promptly.
|
|
|
|
## How to Contribute
|
|
|
|
We categorize documentation issues into two main types:
|
|
|
|
* Content Corrections
|
|
* Content Additions
|
|
* Best Practices
|
|
|
|
### Content Corrections
|
|
|
|
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.
|
|
|
|
|
|
|
|
Alternatively, you can post the document link on our [Issues page](https://github.com/langgenius/dify-docs/issues) with a brief description of the necessary modifications. We'll address these promptly upon receipt.
|
|
|
|
### Content Additions
|
|
|
|
To contribute new documentation to our repository, please follow these steps:
|
|
|
|
1. Fork the repository
|
|
|
|
Fork the repository to your GitHub account, then clone the repository to your local:
|
|
|
|
```bash
|
|
git clone https://github.com/<your-github-account>/dify-docs.git
|
|
```
|
|
|
|
> Note: You can also use GitHub's online code editor to submit new Markdown files directly in the appropriate directory.
|
|
|
|
2. Locate the relevant document directory and add your file
|
|
|
|
For instance, if you're contributing documentation for third-party tools, please add new `.md` files to the `/guides/tools/tool-configuration/` directory.
|
|
|
|
3. Submit a pull request
|
|
|
|
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.
|
|
|
|
### Best Practices
|
|
|
|
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:
|
|
|
|
|
|
```text
|
|
1. Introduction
|
|
- Application scenarios and problems addressed
|
|
- Key features and highlights
|
|
- Final results and demonstrations
|
|
|
|
2. Project Principles / Process Overview
|
|
|
|
3. Prerequisites (if any)
|
|
- Required resource list
|
|
- Tool and dependency requirements
|
|
|
|
4. Implementation in the Dify Platform (Suggested Steps)
|
|
- Application creation and basic configurations
|
|
- Process-building guide
|
|
- Configuration details for key nodes
|
|
|
|
5. FAQ
|
|
```
|
|
|
|
> For images and screenshots, please use online image hosting links in your documentation.
|
|
|
|
We look forward to your valuable contributions and to fostering knowledge within the Dify community together!
|
|
|
|
## Getting Help
|
|
|
|
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.
|
|
|
|
We appreciate your efforts in improving Dify's documentation!
|
|
|
|
{/*
|
|
Contributing Section
|
|
DO NOT edit this section!
|
|
It will be automatically generated by the script.
|
|
*/}
|
|
|
|
<CardGroup cols="2">
|
|
<Card
|
|
title="Edit this page"
|
|
icon="pen-to-square"
|
|
href="https://github.com/langgenius/dify-docs/edit/main/en/community/docs-contribution.mdx"
|
|
>
|
|
Help improve our documentation by contributing directly
|
|
</Card>
|
|
<Card
|
|
title="Report an issue"
|
|
icon="github"
|
|
href="https://github.com/langgenius/dify-docs/issues/new?title=Documentation%20Issue%3A%20contribut&body=%23%23%20Issue%20Description%0A%3C%21--%20Please%20briefly%20describe%20the%20issue%20you%20found%20--%3E%0A%0A%23%23%20Page%20Link%0Ahttps%3A%2F%2Fgithub.com%2Flanggenius%2Fdify-docs%2Fblob%2Fmain%2Fen/community%2Fdocs-contribution.mdx%0A%0A%23%23%20Suggested%20Changes%0A%3C%21--%20If%20you%20have%20specific%20suggestions%20for%20changes%2C%20please%20describe%20them%20here%20--%3E%0A%0A%3C%21--%20Thank%20you%20for%20helping%20improve%20our%20documentation%21%20--%3E"
|
|
>
|
|
Found an error or have suggestions? Let us know
|
|
</Card>
|
|
</CardGroup>
|