You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: AGENTS.md
+8-5Lines changed: 8 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,7 @@
1
1
# Dify Documentation — AI Agent Instructions
2
2
3
+
Documentation for Dify, built with Mintlify. English is the source language; Chinese and Japanese translations are generated automatically. Exception: `en/self-host/configuration/environments.mdx` is excluded from the translation pipeline and must be translated manually.
4
+
3
5
For documentation tasks, read these guides before starting:
@@ -10,11 +12,12 @@ For task-specific guidance, see `writing-guides/index.md`.
10
12
11
13
## Key Rules
12
14
13
-
- Write in English only, except when specifically optimizing Chinese
14
-
or Japanese translations.
15
-
- Only edit the English section in `docs.json`. Translation sections sync
16
-
automatically.
15
+
- Write in English only, except when specifically optimizing Chinese or Japanese translations.
16
+
- Only edit the English section in `docs.json`. Translation sections sync automatically.
17
17
- MDX files require `title` and `description` in YAML frontmatter.
18
+
- When writing about a feature, verify behavior against the Dify codebase, not just existing docs. Existing docs may be outdated.
19
+
- 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.
20
+
- 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`.
18
21
- Never use `--no-verify` when committing.
19
22
20
23
## Repository Structure
@@ -41,4 +44,4 @@ mintlify dev Local preview at localhost:3000
41
44
|`refactor`| Reorganization without content changes |`refactor: restructure knowledge base section`|
42
45
|`translate`| Translation additions or updates |`translate: update Japanese workflow pages`|
43
46
|`style`| Formatting-only changes |`style: fix heading levels in plugin guide`|
44
-
|`chore`| Dependencies, config |`chore: bump mintlify to 4.0.710`|
47
+
|`chore`| Dependencies, config |`chore: bump mintlify to 4.0.710`|
0 commit comments