Riskey
d95f83ca4d
* feat: retire the auto-translation pipeline
* fix: drop the Dify-API translator and align the navigation guideline
* fix: remove unused pipeline-era config and the translation A/B test framework
* fix: retire remaining pipeline references in glossary, env-vars skill, termbase tool
(cherry picked from commit 267089b359)
3.5 KiB
Dify Documentation — AI Agent Instructions
Documentation for Dify, built with Mintlify. English is the source language, and every content change ships all three languages together: finalize the English change, then produce the zh and ja translations in the same pass, following tools/translate/formatting-zh.md, tools/translate/formatting-ja.md, and writing-guides/glossary.md. This applies to external contributions too.
For documentation tasks, read these guides before starting:
writing-guides/style-guide.md— Voice, tone, writing patternswriting-guides/formatting-guide.md— MDX formatting, Mintlify componentswriting-guides/glossary.md— Standardized terminology
For task-specific guidance, see writing-guides/index.md.
Key Rules
- English first: write and finalize content in English, then translate to zh and ja in the same pass per the rules in
tools/translate/. Keep the translation Note at the top of zh/ja pages. docs.jsonhas one navigation section per language. Structural changes (added, moved, renamed pages) must be mirrored across all three sections in the same PR.- MDX files require
titleanddescriptionin YAML frontmatter. - When writing about a feature, verify behavior against the Dify codebase, not just existing docs. Existing docs may be outdated or completely wrong. When rewriting a page, treat every claim in the original as unverified. Check field names, types, required/optional status, and behavior descriptions against the current code. Never carry forward details from legacy docs without independent verification. The backend is split across two repos: built-in workflow nodes, the graph engine, runtime, and model_runtime live in the
graphonrepo (version-pinned indify/api/pyproject.toml); integration nodes (Agent, Knowledge, Datasource, Trigger), orchestration, RAG, and tools stay indify. Verify against the graphon version actually pinned by dify, not graphonmain. - For new features, the user may specify a development branch. Code on development branches may be in flux—when behavior is ambiguous, ask rather than assume.
- When adding or updating internal-only instructions, tooling, configs, or other non-public files, ensure all paths that should not be exposed by Mintlify are covered in
.mintignore. - Never use
--no-verifywhen committing.
Repository Structure
en/, zh/, ja/ Documentation content (en is source) writing-guides/ Style guide, formatting guide, glossary tools/translate/ Translation rules (zh/ja formatting guides, termbase) and utilities .claude/skills/ Documentation writing skills (auto-discovered) docs.json Navigation structure
Development
mintlify dev Local preview at localhost:3000
Commit and PR Title Conventions
{type}: {description} — lowercase, imperative, no trailing period, under 72 chars.
| 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 |