dify-docs/README.md

📘 Dify Documentation (Mintlify Edition)

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

npm i -g mintlify

2. Start local development

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

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

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.