# dify-docs

**Repository Path**: dify_ai/dify-docs

## Basic Information

- **Project Name**: dify-docs
- **Description**: The open-source repo for docs.dify.ai
- **Primary Language**: Unknown
- **License**: CC-BY-4.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 4
- **Forks**: 2
- **Created**: 2023-08-19
- **Last Updated**: 2026-04-16

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Dify Documentation

Official documentation for [Dify](https://dify.ai), available in English, Chinese, and Japanese.

---

## Contributing

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

### Quick Start

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.

### Repository Structure

```
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.

### File Format

Documentation files use MDX with required YAML frontmatter:

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

Page content here...
```

### Commit and PR Conventions

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

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

| Type | When | Example |
|:-----|:-----|:--------|
| `docs` | New or updated content | `docs: add workflow node configuration guide` |
| `fix` | Typos, broken links, incorrect info | `fix: correct broken link in knowledge base page` |
| `feat` | Tooling or structural changes | `feat: add search index to knowledge section` |
| `refactor` | Reorganization without content changes | `refactor: restructure knowledge base section` |
| `translate` | Translation additions or updates | `translate: update Japanese workflow pages` |
| `style` | Formatting-only changes | `style: fix heading levels in plugin guide` |
| `chore` | Dependencies, config | `chore: bump mintlify to 4.0.710` |

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.
```

### Local Preview

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

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

### Setup

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

```bash
git config core.hooksPath .githooks
```

### Formatting Standards

We maintain a formatting guide in [`writing-guides/formatting-guide.md`](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.

### AI-Assisted Contributing

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.

### Guidelines

- **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.