docs: sync docs for CE 1.17.0 - #961
Open
RiskeyL wants to merge 38 commits into
Open
Conversation
dify #40142 consolidates deployment edition configuration: DEPLOYMENT_EDITION (COMMUNITY, ENTERPRISE, CLOUD) replaces EDITION, ENTERPRISE_ENABLED, and BILLING_ENABLED, which are ignored from 1.16.2 onward. Updates the General table row and the Record Retention wording in all three languages, plus the env-var skill's removed-variable handling rules and the affected ignore-list entries.
GRAPH_ENGINE_SCALE_UP_THRESHOLD default corrected to 0 with the new pending-task semantics (graphon #197). New rows: KEY_PROVIDER_TYPE with the Azure Key Vault provider group (dify #39933), TIDB_VECTOR_ENABLE_FULLTEXT_SEARCH (dify #38112), PLUGIN_MAX_FILE_SIZE, and MARKDOWN_FORM_FIELD_NAME_EXTRA_CHARS (dify #40070). Ignore-list entries added for the Cloud-only and Enterprise-only variables introduced in this range.
Batch document metadata update now returns 404 for missing dataset, document, or metadata IDs; the adjacent 400 description drops the moved cause (dify #40149). The nine vector-space-checked operations document the Cloud Sandbox-only 503 returned when usage cannot be verified (dify #39967).
The Studio revamp (dify #39829) consolidates app access configuration into the Access Point tab. Publish pages, the trigger overview, and three tutorials now point there; the glossary gains the Access Point tab row, the channel card labels, and the renamed publish-panel states. Also corrects the zh lesson-10 button-state description and two ja UI labels.
Workflow environment variables gain an LLM type that holds a shared model configuration (dify #39125). The LLM node page explains binding the Model field to a variable, key concepts covers the new type, and the snippet page documents that bindings are inlined as fixed settings on snippet creation.
The classic Agent app is being labeled legacy to distinguish it from the New Agent (upstream DIFY-2746; verify the badge against the shipped 1.16.2 UI before merge).
Both pre-fill entry points now go through the Access Point tab's Web App card: Configure for the shareable-link flow and Embed Into Site > Pre-Fill Hidden Fields for embedding, verified against the running UI with key-traced labels in all three languages (common.operation.config, appInfo.launch).
Delta sweep 28ba7033fa..08993dd622: the conversation-deletion safety-net task's three variables (dify #40792) join the Celery Beat table; TURNSTILE_SITE_KEY joins the Cloud-only ignore list (dify #40569); the audio-to-text MIME list notes the audio/x-m4a alias (dify #40776).
* docs: add skills overview and skill library guides Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * docs: clarify skill-resource pairing sentence in skills overview Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * docs: streamline skills guides wording after review Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * docs: skills can be referenced in prompt regardless of source Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * docs: merge skills guides into one page and refine agent skills section Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> * docs: refine skills create-flow structure and agent skills notes Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> * docs: align skills page with style conventions and tidy wording Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> * docs: drop redundant "as context" from skill builder file-types line Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> * docs: document skill upload limit env var and tidy skills sections Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * style: inline skill upload limit env var per docs convention Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * docs: move skill library capacity into library intro Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * fix: filter skills by tags, not the library Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * docs: align skill pages with unified limits and PRD updates Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * docs: tighten skills example and upload limit wording Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * docs: update skill builder attachment types and limits Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * docs: describe version restore as draft replacement Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * docs: refine skill management guidance * docs: clarify skill package file limit * docs: standardize skill terminology * translate: sync skill management docs --------- Co-authored-by: yajing <yaaahjing@dify.ai> Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
* docs: document the email-code login limits dify #40960 hardens email-code sign-in: EMAIL_CODE_LOGIN_TOKEN_EXPIRY_MINUTES and EMAIL_CODE_LOGIN_MAX_ATTEMPTS join the Authentication and Accounts group in all three languages. TURNSTILE_EMAIL_CODE_VERIFY_REQUIRED is ignore-listed with its Cloud-only siblings (the check runs inside the DEPLOYMENT_EDITION == CLOUD gate). * fix: cite the turnstile gate by file path only
…951) Discord feedback (Linear COM-13632): the quick-start clone command resolves the latest version via the GitHub API and degrades to git clone --branch null when the request fails. Add an action-first fallback with an explicit-version command to the Info callout, and a searchable FAQ entry explaining the failure and what a bare clone actually deploys, in all three languages. Also fix three pre-existing missing-blank-line violations in the touched files. Ref: DC-222
* docs: revise New Agent guide pages for 1.17.0 * docs: update New Agent environment variable reference * docs: expand docker compose upgrade guidance * docs: add New Agent terms to the glossary
…review-version fix: correct skill preview and version instructions
…954) * docs: update the tts response contract and new trace and agent vars The text-to-audio 200 response no longer claims audio/mpeg: upstream now sniffs the provider's container and sets Content-Type accordingly (AAC/FLAC/MP4/MP3/Ogg/WAV/WebM), so the description is rewritten and the response media type becomes application/octet-stream, matching the upstream annotation. AGENT_BACKEND_HOME_SNAPSHOT_TIMEOUT_SECONDS joins the agent backend rows. The two unified ops-tracing vars are ignore-listed as a default-off migration flag pair with a drop-when-shipped note. Verified against dify main 24287bcb0c. * fix: segment and complete the tts and agent var descriptions Post-draft self-check round: the TTS 200 description gains the unrecognized-output fallback (audit-verified: provider-declared type, else audio/mpeg) and splits into semantic blocks; the agent snapshot timeout row is rewritten impact-first with symptom guidance and a cell break. Env verifier and all spec gates pass at dify main 24287bcb0c. * fix: enumerate the tts audio media types and align agent casing
…955) * feat: scope release-branch edits to self-host and fix table conventions (#943) * feat: scope release-branch edits to self-host and fix table conventions * fix: clarify that copy scope splits cloud vs self-host, not languages * feat: require i18n key resolution for ui labels Documenting a UI label means resolving the exact i18n key the component renders, not matching values across namespaces. The rule lands in the glossary's UI Labels section as the single-source home; the terminology-check skill gains a multiple-hit disambiguation substep, and both translate formatting guides point at the rule. * feat: require a post-writing self-check before presenting docs work * fix: pin the ref in the glossary lookup and refine the media type rule * fix: make the glossary key lookup quote-agnostic * fix: use fixed-string raw-key search in the component trace step
chore: merge main into release/1.17.0
docs: update go to anything for the discovery redesign
docs: fix New Agent limits, output contract, and env var links
…ferences fix: correct skill file support and DSL sharing guidance
dosubot
Bot
added
size:L
Contributor
There was a problem hiding this comment.
Pull request overview
Synchronizes the documentation set for Community Edition 1.17.0 across the English, Chinese, and Japanese trees, covering UI changes (notably the Access Point surfaces), New Agent/Skills updates, environment-variable reference updates, and API reference contract corrections.
Changes:
- Updates multiple user-guide pages and tutorials to reflect the Access Point–based publishing/discovery UX (web app, embeds, MCP, triggers).
- Adds Skills library documentation and updates glossary/termbase to standardize “skill” terminology and related UI labels.
- Updates env-var reference and OpenAPI specs for 1.17.0 behavior (new/renamed variables, agent backend settings, and audio response contracts).
Reviewed changes
Copilot reviewed 85 out of 87 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| zh/self-host/use-dify/publish/webapp/embedding-in-websites.mdx | Repoints embed-token instructions to Access Point. |
| zh/self-host/use-dify/publish/README.mdx | Updates publish steps (Access Point, UI emphasis). |
| zh/self-host/use-dify/publish/publish-mcp.mdx | Repoints MCP setup instructions to Access Point; removes screenshot. |
| zh/self-host/use-dify/nodes/user-input.mdx | Updates hidden-field prefill flows to Access Point Web App card UX. |
| zh/self-host/use-dify/nodes/trigger/overview.mdx | Updates trigger enable/disable instructions to Access Point Trigger card. |
| zh/self-host/use-dify/nodes/llm.mdx | Documents sharing LLM model config via LLM-type env vars. |
| zh/self-host/use-dify/nodes/http-request.mdx | Documents secret masking behavior in logs. |
| zh/self-host/use-dify/nodes/doc-extractor.mdx | Updates supported office formats (adds ODT via Unstructured). |
| zh/self-host/use-dify/nodes/agent.mdx | Clarifies sandbox isolation, output behavior, truncation, and file cap; links to env vars. |
| zh/self-host/use-dify/build/snippet.mdx | Clarifies snippet input-variable behavior and LLM env-var exception. |
| zh/self-host/use-dify/build/skills.mdx | New Skills library page (ZH). |
| zh/self-host/use-dify/build/new-agent/overview.mdx | Updates “classic/legacy” naming; refines capability description and logs mention. |
| zh/self-host/use-dify/build/new-agent/build.mdx | Substantial New Agent doc sync (skills model, files, env vars, file system semantics, run limits, troubleshooting). |
| zh/self-host/use-dify/build/goto-anything.mdx | Updates Go to Anything scope and commands (/discord, /models, agent/skill scopes). |
| zh/self-host/use-dify/build/agent.mdx | Adds Legacy tag to classic Agent page. |
| zh/self-host/deploy/quick-start/faqs.mdx | Adds FAQ for GitHub API rate-limit clone failure (“null” branch). |
| zh/self-host/deploy/quick-start/docker-compose.mdx | Adds clone-failure guidance and upgrade note about reapplying compose customizations. |
| zh/self-host/deploy/configuration/environments.mdx | Env-var reference updates for 1.17.0 (DEPLOYMENT_EDITION, Key Vault, agent vars, plugin caps, cleanup tasks, etc.). |
| zh/learn/tutorials/workflow-101/lesson-10.mdx | Updates publish steps and Access Point explanation. |
| zh/learn/tutorials/customer-service-bot.mdx | Repoints embed instructions to Access Point Web App card. |
| zh/learn/tutorials/build-ai-image-generation-app.mdx | Updates post-publish action label (“Open web app”). |
| zh/learn/key-concepts.mdx | Updates env-var concept to include shared LLM model config. |
| zh/develop-plugin/dev-guides-and-walkthroughs/tool-plugin.mdx | Documents new tool param types date / date-range. |
| zh/api-reference/openapi_service.json | Updates response contracts and error cases (audio content types, 503 sandbox behavior, metadata update errors, audio/x-m4a). |
| writing-guides/index.md | Strengthens post-writing verification requirement language. |
| writing-guides/glossary.md | Adds/updates Skills-related terminology and Access Point/UI label mappings. |
| tools/translate/termbase_i18n.md | Mirrors glossary Skills/UI label additions for translation consistency. |
| ja/self-host/use-dify/publish/webapp/embedding-in-websites.mdx | Repoints embed-token instructions to Access Point (JA). |
| ja/self-host/use-dify/publish/README.mdx | Updates publish steps (Access Point, UI emphasis) (JA). |
| ja/self-host/use-dify/publish/publish-mcp.mdx | Repoints MCP setup instructions to Access Point; removes screenshot (JA). |
| ja/self-host/use-dify/nodes/user-input.mdx | Updates hidden-field prefill flows to Access Point Web App card UX (JA). |
| ja/self-host/use-dify/nodes/trigger/overview.mdx | Updates trigger enable/disable instructions to Access Point Trigger card (JA). |
| ja/self-host/use-dify/nodes/llm.mdx | Documents sharing LLM model config via LLM-type env vars (JA). |
| ja/self-host/use-dify/nodes/http-request.mdx | Documents secret masking behavior in logs (JA). |
| ja/self-host/use-dify/nodes/doc-extractor.mdx | Updates supported office formats (adds ODT via Unstructured) (JA). |
| ja/self-host/use-dify/nodes/agent.mdx | Clarifies sandbox isolation, output behavior, truncation, and file cap; links to env vars (JA). |
| ja/self-host/use-dify/build/snippet.mdx | Clarifies snippet input-variable behavior and LLM env-var exception (JA). |
| ja/self-host/use-dify/build/skills.mdx | New Skills library page (JA). |
| ja/self-host/use-dify/build/new-agent/overview.mdx | Updates “classic/legacy” naming; refines capability description and logs mention (JA). |
| ja/self-host/use-dify/build/goto-anything.mdx | Updates Go to Anything scope and commands (/discord, /models, agent/skill scopes) (JA). |
| ja/self-host/use-dify/build/agent.mdx | Adds Legacy tag to classic Agent page (JA). |
| ja/self-host/deploy/quick-start/faqs.mdx | Adds FAQ for GitHub API rate-limit clone failure (“null” branch) (JA). |
| ja/self-host/deploy/quick-start/docker-compose.mdx | Adds clone-failure guidance and upgrade note about reapplying compose customizations (JA). |
| ja/self-host/deploy/configuration/environments.mdx | Env-var reference updates for 1.17.0 (JA). |
| ja/learn/tutorials/workflow-101/lesson-10.mdx | Updates publish steps and Access Point explanation; aligns UI labels (JA). |
| ja/learn/tutorials/customer-service-bot.mdx | Repoints embed instructions to Access Point Web App card (JA). |
| ja/learn/tutorials/build-ai-image-generation-app.mdx | Updates post-publish action label (“Web アプリを開く”) (JA). |
| ja/learn/key-concepts.mdx | Updates env-var concept to include shared LLM model config (JA). |
| ja/develop-plugin/dev-guides-and-walkthroughs/tool-plugin.mdx | Documents new tool param types date / date-range (JA). |
| ja/api-reference/openapi_service.json | Mirrors OpenAPI contract updates (JA). |
| en/self-host/use-dify/publish/webapp/embedding-in-websites.mdx | Repoints embed-token instructions to Access Point. |
| en/self-host/use-dify/publish/README.mdx | Updates publish steps (Access Point, UI emphasis). |
| en/self-host/use-dify/publish/publish-mcp.mdx | Repoints MCP setup instructions to Access Point; removes screenshot. |
| en/self-host/use-dify/nodes/user-input.mdx | Updates hidden-field prefill flows to Access Point Web App card UX. |
| en/self-host/use-dify/nodes/trigger/overview.mdx | Updates trigger enable/disable instructions to Access Point Trigger card. |
| en/self-host/use-dify/nodes/llm.mdx | Documents sharing LLM model config via LLM-type env vars. |
| en/self-host/use-dify/nodes/http-request.mdx | Documents secret masking behavior in logs. |
| en/self-host/use-dify/nodes/doc-extractor.mdx | Updates supported office formats (adds ODT via Unstructured). |
| en/self-host/use-dify/nodes/agent.mdx | Clarifies sandbox isolation, output behavior, truncation, and file cap; links to env vars. |
| en/self-host/use-dify/build/snippet.mdx | Clarifies snippet input-variable behavior and LLM env-var exception. |
| en/self-host/use-dify/build/skills.mdx | New Skills library page (EN). |
| en/self-host/use-dify/build/new-agent/overview.mdx | Updates “classic/legacy” naming; refines capability description and logs mention. |
| en/self-host/use-dify/build/new-agent/build.mdx | Substantial New Agent doc sync (skills model, files, env vars, file system semantics, run limits, troubleshooting). |
| en/self-host/use-dify/build/goto-anything.mdx | Updates Go to Anything scope and commands (/discord, /models, agent/skill scopes). |
| en/self-host/use-dify/build/agent.mdx | Adds Legacy tag to classic Agent page. |
| en/self-host/deploy/quick-start/faqs.mdx | Adds FAQ for GitHub API rate-limit clone failure (“null” branch). |
| en/self-host/deploy/quick-start/docker-compose.mdx | Adds clone-failure guidance and upgrade note about reapplying compose customizations. |
| en/self-host/deploy/configuration/environments.mdx | Env-var reference updates for 1.17.0 (DEPLOYMENT_EDITION, Key Vault, agent vars, plugin caps, cleanup tasks, etc.). |
| en/learn/tutorials/workflow-101/lesson-10.mdx | Updates publish steps and Access Point explanation. |
| en/learn/tutorials/customer-service-bot.mdx | Repoints embed instructions to Access Point Web App card. |
| en/learn/tutorials/build-ai-image-generation-app.mdx | Updates post-publish action label (“Open web app”). |
| en/learn/key-concepts.mdx | Updates env-var concept to include shared LLM model config. |
| en/develop-plugin/dev-guides-and-walkthroughs/tool-plugin.mdx | Documents new tool param types date / date-range. |
| en/cloud/use-dify/publish/README.mdx | Removes publish-methods frame (Cloud tree). |
| en/api-reference/openapi_service.json | Updates response contracts and error cases (audio content types, 503 sandbox behavior, metadata update errors, audio/x-m4a). |
| docs.json | Adds the Skills page to nav in all three languages. |
| AGENTS.md | Reinforces post-writing verification requirement. |
| .claude/skills/dify-docs-write/SKILL.md | Clarifies S7 verification applies universally. |
| .claude/skills/dify-docs-terminology-check/SKILL.md | Tightens UI-label verification procedure. |
| .claude/skills/dify-docs-guides/SKILL.md | Adds rule about linking only to env-var heading anchors. |
| .claude/skills/dify-docs-env-vars/SKILL.md | Clarifies deprecated-vs-removed env-var doc rules. |
| .claude/skills/dify-docs-env-vars/references/style-overrides.md | Adds guidance for breaking long table-cell descriptions. |
| .claude/skills/dify-docs-env-vars/ignored-vars.md | Updates ignored vars to DEPLOYMENT_EDITION terminology and adds new ignore entries. |
| .claude/skills/dify-docs-api-reference/references/spec-conventions.md | Updates convention for runtime-selected media type enumeration in OpenAPI. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
…it-copy docs: align skill import package guidance
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documentation for CE 1.17.0, accumulated on
release/1.17.0through iterative sweeps of dify1.16.1..44aec257bfand graphonv0.6.0..v0.7.0(the pin bump in this range). All content ships en, zh, and ja together; merge when the 1.17.0 tag is cut and the final re-diff confirms no slippage.API reference ({en,zh,ja}/api-reference/openapi_service.json)
DEPLOYMENT_EDITIONera: broadened 404 on batch document metadata update with a corrected 400, and the Cloud Sandbox-only 503 documented on the nine vector-space-checked operations (dify #40149, #39967)Content-Typereflects the provider's sniffed audio container, response media types enumerated (AAC/FLAC/MP4/MP3/Ogg/WAV/WebM), fallback documented (dify upstream fix for #35880)audio/x-m4a(dify #40776)Environment variable reference
DEPLOYMENT_EDITIONreplacesEDITION,ENTERPRISE_ENABLED, andBILLING_ENABLED(dify #40142, dedicated commit)GRAPH_ENGINE_SCALE_UP_THRESHOLDdefault and semantics (graphon 文档问题: 关于文件存储配置-cos相关说明的更新 #197)User guides and tutorials
date/date-rangetypes (#36163), Document Extractor ODT (graphon 文档问题: #203), secret masking in run and request logs (graphon 文档问题: onme #217), Legacy badge on the classic Agent app page (upstreamlegacyAgentBadge), skills guides, CLI fixes, and Arize/Phoenix integration clarificationsCloud-tree copies are deliberately excluded and follow Cloud's own release lane. Verified against dify main
44aec257bf; final tag-gate re-diff pending.Closes DC-198
Ref: DC-193, DC-192