Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 12 additions & 2 deletions .mintignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,12 @@
writing-guides/
tools/translate/config.json
# Root-level internal instructions
/AGENTS.md
/CLAUDE.md

# Internal workflow and tooling directories
/.githooks/
/tools/
/writing-guides/

# Non-public utility files under public asset directories
/assets/migrate_weaviate_collections.py
/logo/convertor.html
13 changes: 8 additions & 5 deletions AGENTS.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Dify Documentation — AI Agent Instructions

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.

For documentation tasks, read these guides before starting:

1. `writing-guides/style-guide.md` — Voice, tone, writing patterns
Expand All @@ -10,11 +12,12 @@ For task-specific guidance, see `writing-guides/index.md`.

## Key Rules

- Write in English only, except when specifically optimizing Chinese
or Japanese translations.
- Only edit the English section in `docs.json`. Translation sections sync
automatically.
- Write in English only, except when specifically optimizing Chinese or Japanese translations.
- Only edit the English section in `docs.json`. Translation sections sync automatically.
- MDX files require `title` and `description` in YAML frontmatter.
- When writing about a feature, verify behavior against the Dify codebase, not just existing docs. Existing docs may be outdated.
- 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-verify` when committing.

## Repository Structure
Expand All @@ -41,4 +44,4 @@ mintlify dev Local preview at localhost:3000
| `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` |
| `chore` | Dependencies, config | `chore: bump mintlify to 4.0.710` |
49 changes: 0 additions & 49 deletions CLAUDE.md

This file was deleted.

1 change: 1 addition & 0 deletions CLAUDE.md
Loading