dify-docs

Rule pack for the Dify CLI (`difyctl`) doc set — en/cli/. Covers reader segments, the writing rules, content ownership, and codebase-verification rules. Loaded by dify-docs-write; not an entry point.

Rule pack for the Service API specs ({en,zh,ja}/api-reference/openapi_service.json): spec conventions, app-type scoping, code-verification rules, and the audit machinery. Writing and editing run under dify-docs-write; the standalone audit of an existing spec ("audit the API spec") runs directly from this pack.

Rule pack for the environment variable reference — en/self-host/deploy/configuration/environments.mdx. Carries the tracing procedure, description rules, verifier, and document structure. Loaded by dify-docs-write; not an entry point. Its release-sync diff is a standalone procedure invoked by dify-docs-release-sync.

Research a Dify feature before writing or optimizing documentation. Use when starting any doc task that requires understanding a feature's implementation, user pain points, or community feedback. Triggers: 'research this feature', 'investigate the code for', 'what do users say about', 'let's understand how X works before writing', or any documentation task where the current docs are being rewritten or significantly expanded.

Check formatting compliance in changed documentation against writing-guides/formatting-guide.md and tools/translate/formatting-{zh,ja}.md. Routes by path: en/ files get the English linter and rules; zh/ and ja/ files get the CJK linter and rules. Use after finalizing a draft or a translation batch, or when the user says "check formatting", "format check", "format audit", or "check CJK formatting".

Rule pack for Dify user-guide pages — en/{cloud,self-host}/use-dify/, en/develop-plugin/, and en/self-host/deploy/. Carries the reader personas (master copy), audience-voice rules, dual-copy discipline, and env-var presentation patterns. Loaded by dify-docs-write; not an entry point.

Post-writing verification from the reader's perspective. Invoke after completing any documentation task to simulate a real user reading the document for the first time.

Use when preparing documentation updates for a Dify release — either comparing two version references (e.g., v1.13.2 and v1.13.3) or prepping ahead of an unreleased version in multiple passes. Covers API reference, help documentation, environment variable changes, and UI i18n glossary impact.

Audit terminology consistency across documentation against the codebase UI labels and the glossary. Covers full files, not just diffs; excludes env var docs. Use after finalizing a draft, or when the user says "check terminology", "check terms", "verify glossary", or "terminology audit".

The entry point for writing or revising ANY documentation in this repo — user guides, deployment pages, plugin-dev pages, API specs, the env-var reference, CLI pages. Resolves the work type and doc type, then runs the eight-stage pipeline (intake → research → task analysis → scope gate → draft → translate → verify → close). Triggers: "write docs for X", "document X", "update this page", "fix/correct this doc", "rewrite/optimize X", "add a page for X".