dify-docs-format-check-en

Documentation formatting checks identify changed .md and .mdx files under the en/ directory, running a bundled Python linter for deterministic rule violations and reviewing editorial style issues like headings and lists.

Linting English documentation against the Dify writing guide involves running the bundled Python linter to catch deterministic formatting errors, followed by a structured review of full files for judgment-based style issues that automation cannot reliably decide.

The documentation format checker does not modify files directly. It preserves the raw grouped linter output and reports formatting issues without altering your .md and .mdx files, ensuring a safe pre-merge audit process.

You can use this editorial review tool for untracked and staged changes. It detects relevant English Markdown and MDX files from unstaged, staged, and untracked Git changes, making it useful during documentation drafting and final pre-merge audits.

During a judgment-based editorial review, documentation elements like headings, emphasis, lists, links, images, tables, and Mintlify component content are checked for style issues that deterministic linter rules cannot reliably evaluate.