An open API service indexing awesome lists of open source software.

https://github.com/langgenius/dify-docs


https://github.com/langgenius/dify-docs

Last synced: 3 days ago
JSON representation

Awesome Lists containing this project

README

          

## πŸ“˜ Dify Documentation

Welcome to the documentation repository for Dify.

We warmly welcome your contributions β€” whether it’s proofreading, fixing typos, or submitting new content. Please feel free to open issues or PRs if you find anything that could be improved!

## πŸš€ Project Overview

This project uses the Mintlify Kit to build and serve modern, developer-friendly documentation.

## πŸ› οΈ Local Development

To preview and develop documentation locally:

1. Install the Mintlify CLI.

```bash
npm i -g mintlify
```

2. Start local development.

Run the following command at the root of your project (where docs.json is located):

```bash
mintlify dev
```

## πŸ™Œ Contributing

Your help in reviewing, editing, and expanding the documentation is truly appreciated.

### πŸ“ Contribution Workflow

1. Fork this repository to your own GitHub account.
2. Create a new branch based on the `main` branch.
3. Start the local development server following the steps above to preview your changes live.
4. Make your edits or write new content in the appropriate file under the content/ directory.
5. Submit a Pull Request (PR) after verifying your changes:

- If you’ve added new pages or sections, don’t forget to update docs.json to include them in the sidebar navigation.
- We welcome tri-lingual contributions (English, Simplified Chinese, Japanese) β€” contribute in one or more languages if possible.

Please submit PRs to this repository instead of the legacy one: πŸ“˜ https://github.com/langgenius/dify-docs-archived

Thanks again for being part of Dify’s documentation journey!

## πŸ“„ License

The Dify product documentation in the assets, content, and data folders are licensed under a [CC-BY license](LICENSE).