docs: 1.14 release documentation by RiskeyL · Pull Request #763 · langgenius/dify-docs

RiskeyL · 2026-04-29T03:34:54Z

No description provided.

* docs: sync App Toolkit page with follow-up settings PR and UI labels * fix: correct CJK format linter false positives * chore: broaden post-writing audit scope to whole documents * docs: address Copilot review on PR #754 Restore the Tab titles rule in formatting-zh.md, which had been trimmed to a stub. Drop the First-Mention Rule entry from the terminology-check skill's Output Format so the report sections match the Checks to Perform sections (the corresponding check was removed earlier). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

* docs: add workflow collaboration user guide * docs: tighten style and formatting guides * docs: avoid "please" in zh refer-to phrases * fix: add CJK-Latin spacing in translation notice templates * docs: add env var coordination to dify-docs-guides skill * docs: document collaboration environment variables * style: trim collaboration env var descriptions for consistency * docs: add zoom menu tip for hiding comments and cursors * docs: sync collaboration UI labels after upstream localization

…759) * docs: rewrite orchestration logic and extend workflow-chatflow overview * translate: update zh and ja for orchestration logic and overview * docs: refine orchestration logic node reuse section * docs: clarify MAX_TREE_DEPTH env var description * fix: align zh title and body references with the glossary UI label * fix: align EN node reuse text with zh/ja translations (User Input exception) Agent-Logs-Url: https://github.com/langgenius/dify-docs/sessions/00e54676-8a43-4b6f-99f8-fef2495b054f Co-authored-by: RiskeyL <36894937+RiskeyL@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>

* feat: add env var ignore-list consumed by the verifier * docs: add 1.14 env vars and correct drifted defaults * fix: correct knowledge pipeline datasource-plugins response in api references * chore: record 1.14 env var traces in deep-dive * docs: update HITL Service API documentation * docs: clarify /api-reference/ link convention in formatting guide * docs: update marketplace publish flow * fix: drop duplicate workflow_run_id from HITL event data schemas The three HITL event schemas (StreamEventHumanInputRequired, StreamEventHumanInputFormFilled, StreamEventHumanInputFormTimeout) declared `workflow_run_id` inside `data.properties`, but `HumanInputRequiredResponse` in `api/core/app/entities/task_entities.py` defines `workflow_run_id` only as a top-level field on the response (alongside `event` and `task_id`); its inner `Data` class doesn't carry one. The OpenAPI spec already provides top-level `workflow_run_id` via the `$ref: StreamEventBase` in the `allOf` composition, so the inline duplicate was a phantom field that doesn't exist in the actual payload. Remove the inline `workflow_run_id` from `data.properties` in all three HITL event schemas across all six spec files. This relies on `StreamEventBase` to provide `workflow_run_id` at the top level via composition, matching how every other event schema in this spec handles it (e.g., `StreamEventWorkflowStarted`). Reported by Copilot on PR #756. * fix: address Copilot's review comments * feat: skip api-reference paths in internal link checker The /api-reference/... URL convention (no language prefix, derived from OpenAPI tag/summary) generates pages that Mintlify auto-builds rather than from filesystem MDX files, so the existing filesystem resolution logic flags every such link as broken. Skip both filesystem-existence and anchor validation for any URL containing /api-reference/, mirroring the existing anchor_check_skipped behaviour. The convention is documented in writing-guides/formatting-guide.md. Caveat: typos in tag or summary slugs will now pass silently. A follow-up could parse the OpenAPI specs to validate against the real tag/summary kebab pairs if hand-written api-reference links become common enough to warrant it. * fix: correct CORS anchor in ja environments page Inline link [CORS設定](#cors 設定) used a literal space, but the heading "CORS 設定" slugifies to "cors-設定" (whitespace replaced with hyphen). Update the anchor to #cors-設定. * fix: align datasource-plugins is_published and 200 description with node framing * fix: clarify chatflow stream workflow events task_id origin * docs: address HITL Service API reader-test feedback

Copilot

Pull request overview

Updates the 1.14 release documentation across English/Chinese/Japanese, including new collaboration docs, refreshed workflow/chatflow orchestration guidance, and expanded API reference details (notably Human Input / SSE behavior), plus supporting writing/validation tooling updates.

Changes:

Add Collaboration documentation pages and update navigation entries.
Revise workflow/chatflow guides and node docs (UI label updates, new tables/clarifications, updated images).
Extend OpenAPI specs and docs tooling (Human Input endpoints/events, API-reference link handling, formatting/terminology guidance).

Reviewed changes

Copilot reviewed 47 out of 50 changed files in this pull request and generated 5 comments.

Show a summary per file

File	Description
zh/use-dify/publish/publish-to-marketplace.mdx	Updates publish flow steps for Marketplace publishing in Chinese docs.
zh/use-dify/nodes/human-input.mdx	Updates WebApp channel naming and adds Service API note/link for Human Input form handling.
zh/use-dify/nodes/answer.mdx	Renames “答案” to “直接回复” and updates captions/wording accordingly.
zh/use-dify/build/workflow-collaboration.mdx	New Chinese page documenting real-time collaboration and canvas comments.
zh/use-dify/build/workflow-chatflow.mdx	Adds a start/end node comparison table for Workflow vs Chatflow (Chinese).
zh/use-dify/build/orchestrate-node.mdx	Rewrites orchestration guidance and swaps to local image asset (Chinese).
zh/use-dify/build/additional-features.mdx	Updates feature names/descriptions and some UI label references (Chinese).
zh/self-host/configuration/environments.mdx	Adds/updates env var docs (collaboration, Redis, Compose healthcheck, etc.) and improves wording.
zh/api-reference/openapi_workflow.json	Expands SSE description and adds Human Input endpoints/schemas (Chinese OpenAPI).
zh/api-reference/openapi_knowledge.json	Adjusts schema nullability and updates datasource listing semantics (Chinese OpenAPI).
zh/api-reference/openapi_chatflow.json	Expands SSE description and adds Human Input endpoints/schemas (Chinese OpenAPI).
writing-guides/style-guide.md	Refines guidance around concision, bullets, and UI/feature naming patterns.
writing-guides/index.md	Clarifies writing workflow steps and audit scope.
writing-guides/glossary.md	Adds glossary terms (e.g., lowercase “workflow”, Trigger) and collaboration UI labels section.
writing-guides/formatting-guide.md	Adds rule for API reference links omitting language prefix and updates punctuation guidance.
tools/translate/formatting-zh.md	Updates Chinese translation rules, including “avoid 请” in refer-to phrasing.
tools/translate/config.json	Updates translation notice templates (spacing and JP notice formatting).
tools/check-links.py	Skips filesystem/anchor validation for `/api-reference/...` links in internal link checker.
ja/use-dify/publish/publish-to-marketplace.mdx	Updates publish flow steps for Marketplace publishing (Japanese).
ja/use-dify/nodes/human-input.mdx	Updates formatting, adds Service API note/link, and standardizes “WebApp” naming (Japanese).
ja/use-dify/build/workflow-collaboration.mdx	New Japanese page documenting real-time collaboration and canvas comments.
ja/use-dify/build/workflow-chatflow.mdx	Adds start/end node comparison table (Japanese).
ja/use-dify/build/orchestrate-node.mdx	Rewrites orchestration guidance and swaps to local image asset (Japanese).
ja/use-dify/build/additional-features.mdx	Updates feature descriptions and some UI label references (Japanese).
ja/api-reference/openapi_knowledge.json	Adjusts schema nullability and updates datasource listing semantics (Japanese OpenAPI).
en/use-dify/publish/publish-to-marketplace.mdx	Updates publish flow steps for Marketplace publishing (English).
en/use-dify/nodes/human-input.mdx	Adds Service API note/link for WebApp Human Input form handling (English).
en/use-dify/build/workflow-collaboration.mdx	New English page documenting real-time collaboration and canvas comments.
en/use-dify/build/workflow-chatflow.mdx	Adds start/end node comparison table (English).
en/use-dify/build/orchestrate-node.mdx	Rewrites orchestration guidance and swaps to local image asset (English).
en/use-dify/build/additional-features.mdx	Updates follow-up questions section and fixes UI label casing (“Add annotation”).
en/self-host/configuration/environments.mdx	Adds/updates env var docs (collaboration, Redis, Compose healthcheck, etc.) and improves wording.
en/api-reference/openapi_workflow.json	Expands SSE description and adds Human Input endpoints/schemas (English OpenAPI).
en/api-reference/openapi_knowledge.json	Adjusts schema nullability and updates datasource listing semantics (English OpenAPI).
en/api-reference/openapi_chatflow.json	Expands SSE description and adds Human Input endpoints/schemas (English OpenAPI).
docs.json	Adds new pages to nav and reorders orchestration/collaboration entries.
.claude/skills/dify-docs-terminology-check/SKILL.md	Updates terminology-check scope and emphasizes codebase i18n as source of truth.
.claude/skills/dify-docs-guides/SKILL.md	Adds guidance for presenting env var requirements in user guides vs reference docs.
.claude/skills/dify-docs-format-check-en/SKILL.md	Updates format-check guidance to audit whole files, not just diffs.
.claude/skills/dify-docs-format-check-cjk/check-format-cjk.py	Fixes bold/CJK spacing detection and improves stripping of markdown image syntax.
.claude/skills/dify-docs-format-check-cjk/SKILL.md	Updates CJK format-check guidance to audit whole files.
.claude/skills/dify-docs-env-vars/verify-env-docs.py	Adds ignored-vars support to reduce verifier false positives.
.claude/skills/dify-docs-env-vars/ignored-vars.md	New curated list of intentionally-ignored env vars with traceability.
.claude/skills/dify-docs-env-vars/deep-dive.md	Adds 1.14 env var deep-dive notes and traces defaults/behavior to code.
.claude/skills/dify-docs-env-vars/SKILL.md	Documents ignored-vars workflow and verifier behavior.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-04-29T03:39:44Z

                    "type": "string",
-                    "description": "Form ID for submitting the response."
+                    "description": "Identifier for the form instance, surfaced in error messages and logs. Use `form_token` for Service API calls."
                  },


StreamEventHumanInputRequired schema omits the workflow_run_id property, but other workflow-related stream events include it (e.g., StreamEventNodeRetry), and the SSE examples include workflow_run_id on human_input_required. Add workflow_run_id (type string/uuid as used elsewhere in this spec) to keep the schema consistent with actual payloads.

Suggested change

},

},

"workflow_run_id": {

"type": "string",

"format": "uuid",

"description": "Workflow run identifier for the execution that requested human input."

},

Copilot · 2026-04-29T03:39:44Z

      "StreamEventHumanInputRequired": {
        "allOf": [
          {
            "$ref": "#/components/schemas/ChunkChatEvent"
          },
          {
            "$ref": "#/components/schemas/StreamEventBase"
          },
          {
            "type": "object",
-            "description": "人工介入节点正在等待用户输入。",
            "properties": {
-              "workflow_run_id": {
-                "type": "string",
-                "description": "工作流执行运行 ID。"
-              },
              "data": {
                "type": "object",
                "properties": {
                  "form_id": {
                    "type": "string",
-                    "description": "用于提交响应的表单 ID。"
+                    "description": "表单实例的标识符，会在错误消息和日志中出现。Service API 调用请使用 `form_token`。"


StreamEventHumanInputRequired 的事件结构缺少 workflow_run_id 字段，但同文件内其他工作流相关事件（如 node_retry）包含该字段，且流式响应示例也带有 workflow_run_id。建议在该事件 schema 顶层补充 workflow_run_id，避免与实际返回不一致。

RiskeyL and others added 5 commits April 27, 2026 14:58

docs: note HTTPS requirement for cross-workflow node paste (#761)

856b5bc

Copilot AI review requested due to automatic review settings April 29, 2026 03:34

dosubot Bot added size:XL This PR changes 500-999 lines, ignoring generated files. documentation Improvements or additions to documentation labels Apr 29, 2026

Copilot started reviewing on behalf of RiskeyL April 29, 2026 03:35 View session

mintlify Bot deployed to staging April 29, 2026 03:35 View deployment

Copilot AI reviewed Apr 29, 2026

View reviewed changes

RiskeyL merged commit dd89e17 into main Apr 29, 2026
7 of 8 checks passed

RiskeyL deleted the release/1.14 branch April 29, 2026 03:58

RiskeyL restored the release/1.14 branch April 29, 2026 03:58

mintlify Bot deployed to staging April 29, 2026 04:00 View deployment

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: 1.14 release documentation#763

docs: 1.14 release documentation#763
RiskeyL merged 5 commits into
mainfrom
release/1.14

RiskeyL commented Apr 29, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Apr 29, 2026

Uh oh!

Copilot AI Apr 29, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

RiskeyL commented Apr 29, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Apr 29, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 29, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants