Official documentation for Dify, available in English, Chinese, and Japanese.

• Contributing
• Viewing Previous Versions

We welcome contributions! All content should be submitted in English only — Chinese and Japanese translations are generated automatically by our translation pipeline.

1. Fork and clone the repository.
2. Create a branch, make your changes, and open a pull request against main.
3. Your PR will be reviewed by a maintainer. Once approved, translations are generated automatically.

dify-docs/
├── en/              # English documentation (source language)
├── zh/              # Chinese translations (auto-generated)
├── ja/              # Japanese translations (auto-generated)
├── writing-guides/  # Style guide, formatting guide, glossary
├── .claude/skills/  # Claude Code documentation skills
├── tools/translate/ # Translation pipeline
├── docs.json        # Navigation structure

• All content changes should be made in the en/ directory. Do not edit zh/ or ja/ directly except when specifically optimizing Chinese or Japanese translations.
• If you add or move a page, update the English section in docs.json — translations sync automatically.

Documentation files use MDX with required YAML frontmatter:

---
title: Your Page Title
description: A brief description of the page content.
---

Page content here...

Commits and PR titles follow the same format: {type}: {description}

• Lowercase, imperative mood ("add", not "added" or "adds").
• No trailing period.
• Under 72 characters.

For non-obvious changes, add a body after a blank line explaining why:

fix: switch API response mode to streaming

Blocking mode was causing HTTP 504 timeouts on large pages.

npm i -g mintlify
mintlify dev

This starts a local development server at http://localhost:3000.

To enable the pre-commit hook (auto-regenerates the terminology database when you commit glossary changes):

git config core.hooksPath .githooks

We maintain a formatting guide in writing-guides/formatting-guide.md. If you use an AI-powered editor or assistant (Cursor, Claude Code, Copilot, etc.), you can point it to that file to check your work before submitting.

This repository includes Claude Code skills in .claude/skills/ that provide writing assistance for different documentation types. If you use Claude Code, these skills are available automatically after cloning.

• One topic per PR. Don't combine unrelated changes.
• English only. Translations are handled automatically, except for en/self-host/configuration/environments.mdx which must be translated manually.
• Update navigation. If you add a new page, add it to the English section of docs.json.
• Test locally. Run mintlify dev to verify your changes render correctly before opening a PR.
• No secrets. Never commit API keys, credentials, or .env files.

Our published documentation site only hosts the latest version of Dify. To view docs for an earlier release, check out the matching release/* branch and preview it locally with the Mintlify CLI.

git clone https://github.com/langgenius/dify-docs.git
cd dify-docs
git checkout release/1.14   # replace with the version you want
npm i -g mintlify
mintlify dev

This serves the historical docs at http://localhost:3000. See the branches list for available release/* versions.