* docs: apply the ready-to-use vs custom knowledge rebrand to Cloud docs
Cloud 1.15.0 ships the same KB creation redesign as CE 1.15.0: the two create entry points are now Create a ready-to-use knowledge base and Build a custom knowledge base, reached through Knowledge > Create. Mirror the self-host rename (305e3f9f) onto the Cloud knowledge pages in all three languages: nav group labels, page titles, create paths, and name-tied prose, plus the bridge from the custom knowledge base page to the knowledge pipeline. Remove the outdated create-entry screenshot, now unreferenced.
* fix: correct list numbering and blank lines in self-host knowledge pages
Fix leftovers from the self-host knowledge creation rename: the zh integrate-knowledge page had two list items numbered 7, and the zh/ja create-knowledge-pipeline pages kept a double blank line where the screenshot Frame was removed.
* fix: correct grammar and formatting flagged in PR #853 review
Address Copilot review feedback, applying each fix to both the cloud and self-host copies to keep the trees in sync: replace "There're" with "There are", fix "one of the knowledge base created", rewrite the comma splice on the custom knowledge base overview, add the missing space before bold Chinese text, and strip trailing whitespace from the create-entry bullets.
(cherry picked from commit 476c02b9d7)
* docs: correct HITL API integration flow and sync translations
- Fix the claim that the resume endpoint differs per app type (same
endpoint; only the entry endpoint differs)
- Tie workflow_run_id guidance to the human_input_required event
(chatflow message chunks don't carry it)
- Require the same user when resuming the event stream (mismatch
returns 404); add include_state_snapshot and continue_on_pause
guidance
- Note at the capture step that a null form_token means Email delivery
- Soften the upload-time validation claim to file size limits
- Split long paragraphs; align zh endpoint name with the reference page
* fix: correct API references against verified backend behavior
Audit of the Service API specs against dify hotfix/1.15.0-fix.1, with
every change code-verified and the serious items adversarially
confirmed. Applies to en/zh/ja.
- Add curl samples for GET endpoints with required query params
(Mintlify omits query params from generated snippets)
- Document 401 once in every spec's auth scheme description
- Correct wrong facts: workflow run detail returns inputs as a JSON
string; DELETE /conversations requires a JSON body; audio-to-text
accepts audio/{mp3,m4a,wav,amr,mpga} by MIME type; workflow log
created_by_account filters by email; triggered_from values are
app-run/webhook/schedule/plugin; stop endpoints' user semantics
differ per app type
- Remove unreachable docs: phantom text_replace SSE event, annotation
403, file preview endpoint in the workflow spec, invented
score_threshold bounds
- Make upload user optional (DEFAULT-USER fallback), fix upload
response example, add missing invalid_param error
- Declare text_to_speech.autoPlay in parameters responses (prose
values, no response-field enums)
* fix: complete API reference audit for knowledge and completion specs
* feat: add API spec consolidation pipeline
Phase-1 of the API docs consolidation: tooling that merges the five per-app-type Service API specs into one openapi_service.json per language, with every divergence resolved explicitly in resolutions.json and rendering-preserving namespacing for mode-scoped schema families. Includes the audit lint and parity checks (lint taught the new language-prefixed href scheme), hand-merged mode-aware SSE documentation for POST /chat-messages in en/zh/ja, and the New Agent (Beta) virtual nav group with code-verified mode notes.
* feat: consolidate API reference into one spec per language
Emit {en,zh,ja}/api-reference/openapi_service.json (82 ops, 130 components) from the audit-fixed per-app-type specs; wire docs.json to them with explicit per-app-type endpoint lists, x-mint.href URLs (/{lang}/api-reference/{tag}/{summary} with shared English slugs for in-place language switching), 265 redirects covering the legacy en and CJK URLs, per-app-type overview pages including New Agent (Beta), and rewritten legacy API links in 21 MDX bodies. The old five specs per language stay as pipeline input; they are no longer rendered.
* fix: remove dead conversation_completed error from chat specs
ConversationCompletedError is never raised anywhere at the verified 1.15.0 ref (7a4252b3de): controllers catch it, but no service code raises it, so the documented 400 conversation_completed can never fire. Remove the bullet and example from the chat and chatflow /chat-messages docs in en/zh/ja. Found and adversarially confirmed during the New Agent (PR #836) verification; filed on the upstream bug list.
* feat: add membership matrix and restructure nav config
* feat: rename resource tags and update all references
* feat: stamp per-operation availability lines
* feat: wire three-group API navigation
* feat: add app-type page coverage lint
* docs: rewrite chatflow overview as app-type API guide
* docs: polish chatflow overview zh and ja wording
* docs: rewrite workflow overview as app-type API guide
* docs: align workflow overview details across languages
* docs: expand new agent overview into app-type API guide
* docs: use task-oriented heading on new agent overview
* docs: rewrite chatbot and agent overview as app-type API guide
* docs: rewrite text generator overview as app-type API guide
* docs: match end user link text to merged spec summary
* docs: rewrite knowledge overview as app-type API guide
* docs: move knowledge api guide into api reference
* docs: localize ui labels on knowledge overview
* docs: refresh pipeline readme for restructure modes
* docs: name app-type pages in the guides sidebar
* feat: rename zh completion messages tag to match resource framing
* docs: prototype endpoints-first layout on chatflow overview
* docs: correct detail accuracy on chatflow overview
* docs: move human input flow guide into api reference
Move the shared HITL API integration walkthrough from its six per-product
copies into {en,zh,ja}/api-reference/guides/human-input-flow as the first
task guide in the API docs. Guides gains an App Types subgroup (expanded
by default) with the flow guide after it; six redirects cover the old
paths; the Human Input node docs and the chatflow overview link to the
new home.
* fix: update spec links to the moved human input guide
* fix: let spec lint accept mdx guide pages under api-reference
* docs: align chatflow zh and ja overviews to endpoints-first layout
* docs: polish chatflow zh and ja mode terms and hitl wording
* docs: align workflow overviews to endpoints-first layout
* docs: document form expiry path in human input flow guide
* docs: align new agent overviews to endpoints-first layout
* docs: align chatbot and agent overviews to endpoints-first layout
* docs: align text generator overviews to endpoints-first layout
* docs: align knowledge overviews to endpoints-first layout
* docs: correct built-in metadata examples and agent heading
* docs: flatten app-type pages directly under guides
* docs: make guide pages self-contained and trim reference detail
* docs: add get started guide and retire developing-with-apis
* docs: update new agent api behavior for latest main
New Agent behavior re-verified against dify origin/main (f3ba2846):
agent_thought events now stream through the Service API carrying the
model's reasoning steps and tool calls; a new agent_not_published 400
fires on Send Chat Message and Get App Parameters; the files claim is
softened to contents-not-processed (raw references now reach the prompt;
runtime confirmation pending). Streaming-only, message_end metadata, and
the endpoint surface are unchanged.
* docs: audit fixes for get started and human input flow guides
* docs: fix em dash spacing and ja sentence length in get started
* docs: move message_end note to the send endpoint line
* docs: update writing guides and API skill for app-type naming
- Glossary and zh/ja translation guides: Workflow and Chatflow app types stay English (Workflow 应用 / Chatflow アプリ); lowercase workflow localizes to 工作流 / ワークフロー.
- formatting-guide: API reference links use the language prefix with English slugs.
- dify-docs-api-reference skill: Spec Structure documents source specs merged into openapi_service.json by the pipeline.
* feat: add operation sidebar titles and simplify API redirects
- merge_specs stamps x-mint.metadata.sidebarTitle per operation so translated summaries show in the sidebar.
- Redirects reduced to a catch-all to the English API home plus three knowledge-base exceptions.
- memberships, strings, and SSE overrides carry app-type labels (Workflow/Chatflow English, New Agent, API Overviews group).
* docs: correct app-type naming and translations across API specs
- English mode enum labels Chatflow and Workflow apps.
- zh/ja app references use Workflow/Chatflow; New Agent is 新 Agent / 新しい Agent.
- ja knowledge tag データセット becomes ナレッジベース; zh 模型提供商 becomes 模型供应商.
- Regenerate merged openapi_service.json with per-operation sidebar titles.
* docs: add streaming, errors, and end-user identity API guides
- Consume Streaming Responses: response modes, SSE parsing, event dispatch, and reconnect.
- Handle Errors and Rate Limits: the error envelope, status classes, and retry guidance.
- End User Identity: what the user field scopes and why it stays consistent.
- English source with zh and ja translations.
* docs: reconcile API guides and apply app-type naming
- Reader-test fixes and content audit on get-started and the app-type overview pages.
- zh/ja reconciled to the English source.
- Workflow/Chatflow and New Agent naming applied in prose.
* feat: wire API nav and redirects for consolidated guides
- Rename the guides group to API Overviews and register the new guide pages.
- Redirects: catch-all to the English API home plus three product-embedded knowledge-base links to the Knowledge guide.
* fix: normalize zh model-provider term to 模型供应商
Aligns the POSITION_PROVIDER_* descriptions with the canonical glossary term.
* docs: use Info callouts for guide forward-link notes
Wrap the authentication, base URL, and `user` field forward-reference in each app-type guide (agent, chat, chatflow, completion, workflow; en/zh/ja) in an `<Info>` callout.
* refactor: remove one-time analyze mode and verification compose
- Drop the `analyze` mode (design-time spec-overlap analysis) and its helpers; the merge is stable and nothing invokes it.
- Delete `compose.swagger.yml`, the throwaway local code-vs-spec verification stack (flagged in review for inline credentials).
- README: drop the analyze entry and correct the redirect description.
* fix: correct Chatflow naming and reasoning wording in SSE overrides
- Use "Chatflow" (English) for the app type in the `/chat-messages` SSE tables instead of 对话流/チャットフロー, and fix the legacy zh chatflow "对话流工作流" description. Standalone table cells were missed by the earlier app-type rename.
- Describe `reasoning_chunk` as "reasoning content" in en/ja (matching the `reasoning` field and the zh wording) instead of "chain-of-thought".
* docs: refine API guide wording and simplify the human-input example
* docs: standardize Workflow and Chatflow app-type capitalization
Capitalize Chatflow and Workflow when they name an app type; keep "workflow" lowercase for the general engine, graph, or run sense.
* fix: use 供应商 for model provider in the zh Knowledge spec
* fix: rename the Knowledge API nav group to "Knowledge APIs"
* fix: un-deprecate Update Document by Text in the Knowledge spec
* translate: un-deprecate Update Document by Text in zh/ja specs
Mirror the en fix (6802d5eb) into the zh and ja Knowledge specs, source and merged: drop the deprecated flag and the leading Deprecated notice from the update-by-text operation. It is the canonical text-update route; only Update Document by File stays deprecated.
* docs: add Human Input file inputs and Service API to Cloud docs
Port the Phase 2 Human Input docs (file inputs and the Service API integration flow) to the Cloud docs, mirroring the self-host pages.
- human-input.mdx (en/zh/ja): add the Single File / File List field type and the file-handling notes; the upload-limit callout states Cloud's fixed limits (documents 15 MB, images 10 MB, audio 50 MB, video 100 MB, up to 10 files) instead of self-host env vars.
- hitl-api-integration-flow.mdx (en/zh/ja): new; identical to self-host since the Service API is the same.
- docs.json: nest the integration-flow under the Human Input group in all three navs.
- zh/ja reuse the self-host translations; only the callout and the /self-host/ links changed.
* docs: rewrite Cloud model providers around AI Credits
* docs: rewrite Cloud subscription management for 1.15.0
* docs: update Cloud code node limits and XLSX image extraction note
* docs: rewrite Cloud team members management for 1.15.0
* docs: apply the 1.15.0 Integrations redesign to Cloud docs
* docs: fix workflow API reference for run-level logs and streaming
* docs: sync self-host use-dify pages and fix translation debt
* docs: align shared tutorials and quick start with 1.15.0
* docs: refine difyctl install examples and workspace reference
* docs: rewrite hotkeys page to match current shortcuts
* fix: correct broken anchor links for badged headings and tabs
* fix: correct env link and Human Input resume identifier
* feat: handle heading badges in link-checker slugs
* fix: repoint publish-mcp cross-links to the merged MCP section
* docs: rename plugin dev CLI to Dify Plugin CLI
* docs: refine CLI reference readability and expand --agent
* feat: stop format checkers flagging indented list-item content
* fix: correct zh/ja custom-endpoint spacing and a list blank line
* docs: clarify Cloud model provider install and AI Credits coverage
* docs: document Human Input file inputs and API flow for self-host
Cover the Human Input node's file-handling additions in the self-host tree: the Single File and File List field types, how file values render as `[file]` / `[N files]` placeholders in `__rendered_content`, and referencing an upstream file variable in Form Content.
Add an API Integration Flow page for the Service API sequence (run, get form, upload via Upload File, submit, resume listening), register it in the self-host nav, add the Single File and File List glossary entries, and refresh the example images.
Verified against dify 1.15.0 and graphon 0.5.3. Self-host only; the Cloud tree is updated separately.
* docs: align Human Input API with HITL-2 form inputs
Update the Human Input endpoints in the workflow and chatflow Service API specs to dify 1.15.0. Document file-mapping submit inputs, where a `file` or `file-list` value is `{transfer_method: local_file, upload_file_id}` (the id from Upload File) or `{transfer_method: remote_url, url}`, and replace the stale `text_input` type with the real `paragraph`, `select`, `file`, and `file-list` values in both the get-form response and the streaming `human_input_required` event.
Make `expiration_time` nullable, drop the unenforced `action` length and pattern constraints, and align the zh delivery-method term with the product UI (提交方式).
* docs: clarify WORKFLOW_FILE_UPLOAD_LIMIT as a per-field cap
The old description read it as the maximum files per workflow execution. It actually bounds the max-files setting on a single file-upload field, such as a User Input or Human Input File List; the node panel's slider is capped at this value. Reword across en, zh, and ja.
* feat: add code-audit step to api-reference skill
Require an independent subagent audit against the codebase after writing or substantially changing endpoints. The brief pins the dify tag and the pinned graphon version, loads the skill references, and calls out the Service-API-vs-web/console controller distinction so the auditor verifies against the blueprint whose base URL matches the spec's servers.
* docs: document file submission details for Human Input API
Following the in-product docs PR (langgenius/dify#37981) and verified against dify 1.15.0 and graphon 0.5.3: a submitted file object carries a `type` from the field's `allowed_file_types`; a `local_file` upload must use the same `user` as the submit, since uploaded files are scoped to that user; and the get-form and submit examples now cover all four input shapes (paragraph, select, file, file-list).
* feat: harden api-reference audit with data-path and example checks
Add two guards to the post-writing code audit: trace opaque request fields to their resolver for ownership and cross-request rules, and diff the spec against the in-product API templates when the endpoint exists there. Add a mechanical example-and-schema consistency pass that checks example keys against schema fields and that every enum and `oneOf` branch is exercised.
* docs: address PR review feedback on Human Input docs
* docs: clarify Human Input API integration flow
Apply reader-test findings and a code-verified correction to the integration flow page and the workflow/chatflow specs.
- Spell out the submit lifecycle: a successful submit is one-shot (closes the form, resumes the run), a rejected one leaves the form open to retry, and the `action` must be one of the form's actions.
- Note the form's `expiration_time` and that the resumed run streams through to completion.
- Make the remote-file mapping concrete (`{transfer_method: remote_url, url}`).
- Soften the file-upload `user` rule to a consistent-`user` recommendation across the run, upload, and submit (verified: the submit `user` is not matched against the run), in the page and both specs.
- Mirror every change into zh and ja.
* fix: correct field name in zh/ja invalid_form_data examples
The zh/ja error examples still referenced `comment`; the earlier fix only caught the English message. Match the `feedback` request example.
* docs: add difyctl CLI documentation
Adds the difyctl doc set under Self-Host > Developer Resources > CLI (en/cli/), Community Edition only for the CE-first launch; the Cloud nav does not reference the CLI yet.
- Aligns the version reference with the 1.15.0 compat window and alpha channel (PR #37794).
- Keeps command-reference Examples command-only, with output in the Output section.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
* translate: add zh/ja Dify CLI documentation
Adds Chinese and Japanese translations of the difyctl CLI doc set (20 pages each) under zh/cli/ and ja/cli/, and registers them in the zh/ja docs.json navigation (CLI under the Self-Host product only, mirroring the English structure). Removes the zh/ja coming-soon placeholders.
Hand-translated following tools/translate/formatting-zh.md, formatting-ja.md, and the terminology base, then audited with the format and terminology checks.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
* Apply suggestions from code review
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
* fix: restore version --short row, align zh env-vars flag section
- version.mdx (zh/ja): restore the --short flag row removed by accident
- environment-variables.mdx (zh): the env list flag section was rendered as 参数 (Arguments); use 标志 (Flags) for the heading and table header, matching the other reference pages
---------
Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Reflect the 1.15.0 onboarding redesign in the self-host knowledge docs. The two create entry points are now Create a ready-to-use knowledge base and Build a custom knowledge base, reached through Knowledge > Create. Update the overview bullets, page titles, nav groups, the in-product create paths, and name-tied prose, and add a bridge from the custom knowledge base page to the underlying knowledge pipeline. Cloud is left unchanged because it keeps the previous UI.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Terminology (en/zh/ja, glossary, termbase, docs.json):
- self-hosted deployment term: zh 自托管 → 自部署; ja consolidates on セルフホスト
- product and edition names stay English in all languages: Dify Cloud, Dify Enterprise, Dify Premium, Community Edition
- "SaaS version" / "Dify SaaS" → Dify Cloud (generic SaaS unchanged)
- docs.json product switcher: Cloud label → English; self-host stays localized
Cloud/CE audience separation and accuracy:
- drop redundant "for self-hosted" / "for Cloud" conditionals within the split trees
- authorize-data-source: correct the OAuth default-client claim (no edition gating in code); self-host keeps only the custom client, Cloud reframes both
- authorize-data-source: move the Custom OAuth process inside the Custom tab (en/zh/ja); align zh to the Tabs layout
- remove the self-hosted-only workflow-collaboration page from the Cloud tree
- docs.json: restore the ja Plugin Development "Getting Started" group dropped as a stray "None"
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Append #mcp to the three self-host build/mcp redirects so the deleted
page resolves to the MCP tab in workspace/tools instead of the page top.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
* fix: trim broken bold markers repo-wide (zh/ja/en)
Remove stray spaces inside `**` delimiters that caused bold to render
literally in CJK text (e.g. `**工作流 **` → `**工作流**`). 88 files
across cloud/, learn/, and quick-start; self-host files with the same
fix are included in the nav-optimize commit.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* docs: update self-host docs for Integrations navigation redesign
Align self-host documentation with the 1.15.0 navigation optimization:
- Regroup docs.json: new Integrations section (Model Provider, Tools,
Custom Endpoint); Workspace shrunk to admin-only pages
- Reframe plugins.mdx as Integrations Overview with hub type list,
permissions, and EE callout
- Merge standalone MCP page into tools.mdx MCP Tool tab; delete
build/mcp.mdx (en/zh/ja)
- Rename all Settings > Model Provider nav paths to Integrations >
Model Provider; Default Model Settings to Default Models; API
Extension to Custom Endpoint; Logs & Annotations split into
separate Logs and Annotations
- Update trigger overview and webhook-trigger: Plugin Trigger to
Integration Trigger; enable/disable moved to Monitoring > Triggers
- Soften concept-level "plugin" references to "integration" across
workspace, knowledge, and build pages
- Update glossary and writing guides for new terminology
- Fix broken bold markers in self-host zh/ja files (same repo-wide
fix as prior commit, for files that also had content changes)
Excludes the plugin-trigger.mdx en rewrite (pending review).
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* docs: add Start Node page, complete trigger rewrites, and apply review fixes
- Add Start Node overview page (en/zh/ja, cloud + self-host) explaining
the User Input vs. Trigger choice; nest under a new Start group in
docs.json with root page support
- Trim Key Concepts to link to the new Start Node page instead of
inlining the details
- Complete Integration Trigger page rewrite (en/zh/ja) with localized
UI strings, trigger integration naming, and subscription flow
- Remove "## Introduction" headings from trigger, schedule-trigger,
webhook-trigger, and user-input pages (en/zh/ja)
- Apply review fixes: user-centric opening for tools.mdx, reframe
auto-update sentence in plugins.mdx, bold Client ID/Secret, remove
tautological sentence, fix "reusable/reuse" redundancy
- Complete remaining API Extension to Custom Endpoint renames in
api-extension, cloudflare-worker, and moderation pages
- Update termbase_i18n.md to match glossary (Integration Trigger,
Integrations, Custom Endpoint, Default Models, Logs/Annotations split)
- Add redirects for deleted self-host build/mcp pages
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* fix: remove duplicate model providers from Integrations parenthetical
The workspace diagram listed Model Providers as its own line and also
inside the Integrations parenthetical. Remove it from the parenthetical
to avoid ambiguity.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
---------
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Relabel the product nav: the tab Use becomes Create (创造 / 作成) and its first group Build becomes Orchestrate (编排 / オーケストレーション). Refresh the section overview hero to match: title "Create with Dify", a goal-oriented subtext that leads with AI applications, and a corrected Orchestrate card that scopes the visual canvas to workflows and chatflows. Paths are unchanged.
Add redirects: the language roots /en, /zh, /ja each point to their /home landing, and the product's End-node link (use-dify/nodes/end) points to the Output node page across languages.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Landings are listed as non-first hidden pages so the navbar language switcher can map them while hidden: true keeps them out of the sidebar; on-page language links are added as a fallback.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
They were registered as the first Cloud Use page with hidden:true, but on the deployed build that neither kept them out of the sidebar nor stopped the product switcher from landing on them. Removing them from the nav fixes both; the pages stay reachable by URL through the existing redirects.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Each language gets a chromeless landing at /{lang}/home, registered as a
hidden first page of that language's Cloud > Use tab so the navbar
language switcher recognizes them as translations of each other. Bare /
redirects to /en/home, and the old-introduction and removed-section
redirects now route by source language to /en/home, /zh/home, or
/ja/home. This replaces the single root index.mdx, whose switcher could
not localize.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
The six zh/ja frame-mode landing pages read as designed surfaces, not
translated articles; the blockquote disclaimer broke the visual flow.
The navbar logo now links to the docs root instead of dify.ai.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
27 new rules map the published structure to the new one: use-dify to
cloud, self-host groups into deploy/, tutorials and key-concepts and
quick-start to shared trees. The 178 legacy redirect destinations
pointing at moved paths are rewritten to final targets to avoid chains,
and two broken legacy destinations are fixed. web-app-access is
intentionally left without a redirect until its EE docs path exists.
Validated by simulating all 748 live sitemap URLs through the rules.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Orientation page as the Deploy tab's front door: deployment method
cards, post-deployment pointers, release notes link, and the EE tip.
The root landing's Self-Host card now points here.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Self-hosters' first task is standing up the instance, so the Self-Host
product now opens on Deploy instead of Use, in all three languages.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Reorganize each product's tabs into a consistent verb set (Use, Deploy, Learn, Develop), with Deploy placed second for Self-Host. Nest the plugin docs under the Develop dropdown and rename its items to API, CLI, and Plugins. Elevate each product's Introduction to the Use tab's front-door Overview, and remove the unused placeholder pages.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Consolidates three previously-split commits that have been reverted for review.
This single commit makes the changes easier to review in one place; the granular
three-commit version is preserved on backup/audience-products-pre-revert if
needed.
Includes:
- Rename the Self-Hosted product path slug from self-hosted to self-host across
en, zh, and ja product trees (505 file renames). docs.json navigation entries
and internal MDX cross-reference links updated to match. Display name
"Self-Hosted" and glossary term unchanged. Legacy /getting-started/install-
self-hosted redirects preserved.
- Tailor 7 Getting Started + Build pages per audience. Cloud versions drop
self-hosted env-var blocks; Self-Host versions inline the verified docker-env
defaults from dify/docker/envs/core-services/shared.env.example
(UPLOAD_FILE_SIZE_LIMIT, UPLOAD_IMAGE_FILE_SIZE_LIMIT, UPLOAD_AUDIO_FILE_SIZE_
LIMIT, ENABLE_COLLABORATION_MODE, SERVER_WORKER_CLASS, NEXT_PUBLIC_SOCKET_URL).
Getting Started quick-start restructured per audience: Cloud signup with AI
Credits; Self-Host deploy + sign in + bring-your-own model provider.
- Tailor 7 Monitor + Publish + Tutorials pages per audience. monitor/logs gets
a Scenario 2 plan-tier callout on Cloud; web-app-settings removes the EE
access-control section on Cloud and keeps it with an Enterprise badge on
Self-Host; integration version-floor callouts dropped from Cloud and rephrased
product-neutrally on Self-Host.
Also includes:
- docs.json: metadata.timestamp = true (user edit)
- en/cloud/use-dify/getting-started/quick-start.mdx: simplified Sign Up step intro
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Phase 1 of the audience-products restructure. Establishes two-product navigation using Mintlify's products primitive, with content moved into per-product paths so each product has its own URL space.
IA composition: languages > products > tabs > {groups | dropdowns | menu | pages}
Cloud product (3 tabs):
- Use Dify
- Developers (menu: API Reference, CLI)
- Plugin
Self-Hosted product (4 tabs):
- Use Dify (dropdowns: User Guide, Admin Guide [EE placeholder])
- Deploy (dropdowns: Community, Enterprise [EE placeholder])
- Developers (menu: API Reference with User API / Admin API dropdowns, CLI)
- Plugin
Filesystem reorganization (en/zh/ja parallel):
- use-dify, develop-plugin, api-reference moved into cloud/, copied into self-hosted/
- self-host moved into self-hosted/deploy/ce
- 9 misfit pages deleted per audit (subscription-management and knowledge-request-rate-limit removed from Self-Hosted; web-app-access removed from Cloud)
- Placeholder MDX for Admin Guide, EE Deploy, Admin API, CLI
Configuration:
- Theme: maple to luma
- Logo href: https://dify.ai
- Navbar: Blog link + Get Started primary button
References:
- Audit: audit/page-audience-classification.md
- Design: ~/Documents/Work/Drafts/2026-04-30-dify-docs-audience-products-design.md
- Progress: ~/Documents/Work/Drafts/2026-05-14-dify-docs-audience-products-progress.md
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
* docs: sync App Toolkit with dify#35442 follow-up settings (#757)
* 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: document workflow collaboration feature (#758)
* 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
* docs: rewrite orchestration logic for cross-workflow node copy-paste (#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>
* docs: note HTTPS requirement for cross-workflow node paste (#761)
* docs: HITL Service API polish and 1.14 release follow-ups (#760)
* 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
---------
Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
* Batch update service apis
* final check and add zh/ja docs
* add temporary redirects for changed api links embedded in the product
* Restore original operationIds to preserve SDK compatibility
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* complete the missing descriptions
* correct the human input terminology
---------
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* fix: remove href from language blocks to preserve page on language switch
Mintlify's language switcher navigates to the explicit href when set,
instead of doing smart path prefix replacement. Removing href lets the
switcher stay on the current page when switching languages.
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
* Revert "fix: remove href from language blocks to preserve page on language switch"
This reverts commit b74b1b8291.
* fix: restructure navigation from versions>languages to languages>versions
Mintlify's language switcher only preserves the current page when
languages are the top-level navigation partition. Previously, versions
were the top level with languages nested inside, causing the switcher
to redirect to the introduction page instead of the same page in the
target language.
Also removes explicit href from language blocks and fixes ja having
default=true incorrectly in the 3.2.x version config.
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
* fix: align zh/ja API spec operationIds with en for language switching
Mintlify generates page URL slugs from operationId. When operationIds
differ between languages (e.g., en: sendChatMessage vs zh:
sendBasicChatMessageCn), the language switcher can't find the
equivalent page and falls back to the introduction page.
This aligns all zh/ja operationIds to match en for endpoints that
share the same HTTP method and path.
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
* fix: align OpenAPI tags across languages for consistent URL slugs
Mintlify uses OpenAPI tags to generate URL category paths (e.g., tag
"Chat" → /chat/). When zh uses "对话消息" and ja uses "チャットメッセージ",
the generated URLs differ from en's, breaking language switching.
This aligns all zh/ja OpenAPI spec tags to match en, ensuring
identical URL structures across languages.
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
* fix: add x-displayName to preserve translated tag names in sidebar
Tags use English names for URL slug generation (consistent across
languages) but x-displayName holds the translated names for display
in the sidebar, so Chinese/Japanese users still see localized labels.
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
* fix: use x-mint href to align API reference URLs across languages
Mintlify generates API page URLs from the tag name + summary, both of
which are translated in zh/ja specs. This produces different URL slugs
(e.g., en: /chat/send-chat-message vs zh: /对话消息/发送对话消息),
making language switching impossible.
Instead of changing the visible content (tags, summaries), this adds
x-mint: { href: ... } to each endpoint in zh/ja specs, explicitly
setting the URL path to match en. All translated content (tags,
summaries, descriptions) is preserved as-is for readers.
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
* fix: add language prefix to x-mint href to prevent cross-language conflicts
Without the language prefix, zh/ja endpoints claimed the same absolute
URL as en (e.g., /api-reference/chat/send-chat-message), causing ja
content to appear on en pages. Now each language has its own prefixed
href (e.g., /zh/api-reference/chat/send-chat-message), keeping content
correctly scoped while enabling language switching.
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
* revert: remove all API spec changes (x-mint href, operationId, tag alignment)
These changes are breaking and need careful coordination with the dev
team before implementation. Only the navigation restructure
(versions>languages → languages>versions) is kept for this PR.
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
* remove all enterprise versions
---------
Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
* draft
* revise based on hands-on testing
* modify based on feedback
* add zh and ja translation
* Update tip for referencing text output variable
Clarify the default behavior of the reasoning model output.
* Add translation note
Added a note about AI translation accuracy and referenced the English version for discrepancies.
* Update human-input.mdx with translation note
Add a note about AI translation accuracy and reference to the English version.
* Apply suggestion from @Copilot
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
* Update wording for clarity on model output display
---------
Co-authored-by: Riskey <riskey47@dify.ai>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
* 🌐 Initial translations for PR #665
Auto-generated translations for documentation changes in PR #665.
Last-Processed-Commit: fe61cffd6d
Original-PR: #665
Languages: Chinese (zh), Japanese (ja)
🤖 Generated with GitHub Actions
* 🔄 Update translations for commit fe61cffd
Auto-generated translations for changes in commit fe61cffd6d.
Last-Processed-Commit: fe61cffd6d
Original-PR: #665
Languages: Chinese (zh), Japanese (ja)
🤖 Generated with GitHub Actions
* 🔄 Update translations for commit d37bc6b5
Auto-generated translations for changes in commit d37bc6b5589e629eac03feb0b7278cba6e75bb0f.
Last-Processed-Commit: d37bc6b5589e629eac03feb0b7278cba6e75bb0f
Original-PR: #665
Languages: Chinese (zh), Japanese (ja)
🤖 Generated with GitHub Actions
* fix the zh link
* fix ja links
* align with en doc
* align with en doc
Remove unnecessary URLs and email addresses for better text cleaning.
* Fix formatting for URL and email removal section
* Fix formatting for URL and email removal section
* align the doc title
---------
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Riskey <36894937+RiskeyL@users.noreply.github.com>
Co-authored-by: RiskeyL <7a8y@163.com>
* create 3.4.x navigation
* add content related to multi-credential management and load balancing for 3-5-x
* add content related to knowledge pipeline for 3-6-x
* add content related to trigger, multimodal embedding, and json object for 3-7-x
* changes upon review
* remove unnecessary links
---------
Co-authored-by: Riskey <riskey47@dify.ai>
* 🌐 Initial translations for PR #636
Auto-generated translations for documentation changes in PR #636.
Last-Processed-Commit: 3f204fbd9d
Original-PR: #636
Languages: Chinese (zh), Japanese (ja)
🤖 Generated with GitHub Actions
* 🔄 Update translations for commit 623b346a
Auto-generated translations for changes in commit 623b346a77.
Last-Processed-Commit: 623b346a77
Original-PR: #636
Languages: Chinese (zh), Japanese (ja)
🤖 Generated with GitHub Actions
* Fix pricing link for batch upload information
Updated the link for the paid plan pricing page.
* Update maintain-knowledge-documents.mdx
* Update link text for knowledge base creation
* Update pricing link in readme for batch upload
* Update setting-indexing-methods.mdx
* Update knowledge-retrieval.mdx
---------
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Riskey <36894937+RiskeyL@users.noreply.github.com>
* recover the original agent strategy docs from old docs repo
* Adjust the navigation order of the plugin dev docs
---------
Co-authored-by: Riskey <riskey47@dify.ai>
* draft
* migrate from old docs repo
* adjust content based on experiencing the feature
* Improvements
* changes upon feedback
* refinements
* zh draft
* add plugin dev docs
* update old links
* add jp docs
* change the position of variables related to multimodal embedding in the environment variable doc
---------
Co-authored-by: Riskey <riskey47@dify.ai>
Riskey