Skip to content

AGENTS.md

Latest commit

 

History

History
47 lines (34 loc) · 2.86 KB

AGENTS.md

File metadata and controls

47 lines (34 loc) · 2.86 KB

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
  2. writing-guides/formatting-guide.md — MDX formatting, Mintlify components
  3. writing-guides/glossary.md — Standardized terminology

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

en/, zh/, ja/ Documentation content (en is source) writing-guides/ Style guide, formatting guide, glossary tools/translate/ Translation pipeline and language-specific formatting .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